Introduction
Welcome to our documentation system! This is a lightweight,Docusaurus-like static site generator that's perfect for hosting documentation on GitHub Pages or GitLab Pages.
Features#
- Markdown-based:Write your documentation in simple Markdown files
- Static Site Generation:Build fast,static HTML pages
- Responsive Design:Works beautifully on all devices
- Easy Navigation:Automatic sidebar and navigation generation
- Search:Client-side search functionality
- Git-friendly:Store everything in version control
Quick Start#
Install dependencies:
Bashnpm installAdd your documentation in the
docs/folderConfigure your site in
config.jsonBuild and preview:
Bashnpm run dev
Next Steps#
Check out the Installation guide to get started!