Welcome to Makit

Makit is a Node.js CLI for creating static documentation sites from Markdown. Write content in Markdown and use TypeScript for site structure and detailed configuration.

Whether you are turning a small project README into a site or building a large portal for several products, you can start with the same approach.

What you can do

• Convert Markdown into an HTML documentation site
• Generate a sidebar automatically from filename ordering
• Configure page titles and navigation with type-safe TypeScript
• Organize large sites with collections, sections, and groups
• Handle localized pages and fallbacks for missing translations
• Deploy static files to GitHub Pages, Cloudflare Pages, Netlify, Vercel, and more

Try it quickly

pnpm add -D @natsuneko-laboratory/makit
pnpm exec makit init
pnpm exec makit dev

Edit the generated docs/index.md to update the page in the development server. For a fuller walkthrough, read Getting started.

Where to go next

1. Getting started — install Makit and build your first site
2. Core concepts — understand the file layout and model
3. Configuration — configure makit.config.ts
4. Content structure — organize a growing site
5. Deployment — publish a static site
6. CLI reference — see all available commands

Learn more about the design

This site presents the repository's specification for users. Refer to it for implementation details and API design background.