Docsome
Zero to docs under 15 seconds.
Docsome is a CLI that transforms any Markdown file into an elegant, static documentation with search and llms.txt. Built on top of Vite and Svelte.
Features
- Development abstracted: You only have to care about the source markdown file.
- Minimal and elegant UI: UI tailored to accomodate any branding.
- Easy to maintain: No separate docs app to care about.
- Fully static: The build is fully static, you won't need any backend to serve requests.
- AI agent friendly:
llms.txtare generated automatically for your site.
Usage
Prerequisite
- Node.js
- Terminal
Building docs
npx docsome build DOCS.md
# or Bun
bunx docsome build DOCS.md
Development server
npx docsome dev DOCS.md
# or Bun
bunx docsome dev DOCS.md
Adding to existing JS app
"scripts": {
"docs:build": "npx docsome build DOCS.md --outDir docs_dist",
"docs:dev": "npx docsome dev DOCS.md",
}
Roadmap
To do
- AI content search
- Code highlighting theme settings
- Toggle for serif font
- Twoslash integration
- OG Image generation
- Define global variables in the frontmatter
- Define a standard for i18n
Done
- Code highlighting
- Mermaid integration
- KaTeX integration
- Top bar, side bar, footer, and announcement customization
- Custom scripts and styles in
<head>
