Installation

This guide will help you set up your documentation system.

Prerequisites#

• Node.js:>= 22.0.0 (LTS recommended)
• npm:>= 10.0.0

If using NVM,you can install and use the correct version:

nvm install 22nvm use

Installation Steps#

1. Clone or download this repository

   Bash

   git clone <your-repo-url>cd doc-system

2. Install dependencies

   Bash

   npm install

3. Configure your site

   Edit config.json to customize your site:

   • Change the title and description
   • Update navbar links
   • Configure the sidebar structure
   • Set your GitHub/GitLab repository URL

Project Structure#

doc-system/├── docs/ # Your markdown documentation files├── theme/ # CSS and JavaScript for the site│ ├── styles.css│ └── search.js├── scripts/ # Build and development scripts│ ├── build.js│ ├── dev.js│ └── serve.js├── config.json # Site configuration└── package.json

Creating Documentation#

Add your documentation as Markdown files in the docs/ folder. Each file should have frontmatter:

---title:Page Titledescription:Page description---# Page TitleYour content here...

Next Steps#

Learn about Configuration to customize your site.