@kyechan99/docgo
v0.3.1
Published
Static documentation site generator
Downloads
152
Readme
Docgo
Static documentation site generator built on React, MDX, and Vite.
Docgo turns Markdown and MDX files into a deployable documentation site with a ready-made docs theme, static search, SEO files, locale/version routing, and LLM-friendly Markdown output.
Install
npm install @kyechan99/docgoQuick Start
npx @kyechan99/docgo init
npx docgo dev
npx docgo buildBy default, Docgo reads from docs and writes the static site to dist.
Build with AI
Give an AI coding agent the following Markdown URL and ask it to integrate Docgo into your project:
https://kyechan99.github.io/docgo/ai.mdThe brief tells the agent how to inspect an existing repository, preserve its
content and conventions, select Docgo features, implement the site, and verify
a production build. A Korean version is available at
https://kyechan99.github.io/docgo/ko/ai.md.
Features
- MDX and GitHub-Flavored Markdown
- responsive docs theme with sidebar, TOC, search, dark mode, and prev/next links
- SEO output including sitemap, robots.txt, Open Graph, JSON-LD, and llms.txt
- locale and version routing
- plugin hooks for config, Markdown, Vite, and generated pages
Development
Docgo requires Node.js 20.19 or newer and uses pnpm. To work on the project:
pnpm install
pnpm run check
pnpm run build:pkgSee CONTRIBUTING.md for the contribution workflow and ARCHITECTURE.md for the codebase map.
License
MIT
