MkDocs

MkDocs is a static website generator designed specifically for project documentation. It uses Markdown to write documents, is simple to configure, and supports real-time preview and full-text search. ###Main characteristics - ** Easy to use **: Write in Markdown, zero threshold to get started - ** Real-time preview **: Editing takes effect immediately without restarting - ** Full-text search **: Automatically generate search index - ** Beautiful theme **: Built-in multiple themes, support customization - ** Persistence storage **: Documents and configurations are saved automatically and are not lost after restarting On the Lazy Cat Network Disk console: App list → MkDocs → App Data / com.txj.mkdocs You will see the following directory structure: com.txj.mkdocs/ ├── mkdocs.yml #Configuration files (control navigation, themes, etc.) ├── docs/ #Document directory (store all.md files) │ ├── index.md #Home │ └── about.md #About the page └── site/ #Generated website (automatically generated without modification) Step 2: Create a new document Create a new file in the docs/directory, such as tutorial.md: #Tutorial This is my first tutorial document. ##Section 1 Tutorial content... Step 3: Update navigation configuration Edit the mkdocs.yml file and add a new page to the navigation: nav: - Home: index.md - About: about.md - Tutorial: tutorial.md #Add this line After saving, refresh your browser to see the new page!