mirror of
https://github.com/pooneyy/1Panel-Appstore.git
synced 2026-03-22 21:09:40 +08:00
11 lines
1.1 KiB
Markdown
11 lines
1.1 KiB
Markdown
# Usage Guide
|
|
Navigate to `/opt/1panel/apps/mkdocs-material/mkdocs-material/data/docs` to start your documentation writing.
|
|
|
|
# Material for MkDocs
|
|
**MkDocs** is a fast, simple, and elegant static site generator suitable for building project documentation. Documentation source files are written in Markdown and configured with a single YAML configuration file.
|
|
|
|
## Features:
|
|
- **Great Themes**: MkDocs offers a variety of beautiful themes, including built-in options like `mkdocs` and `readthedocs`, as well as third-party themes or custom-built ones.
|
|
- **Customizable**: Customize themes and/or install plugins to make your project documentation look exactly as you want. Extend Markdown behavior with Markdown extensions and configuration options.
|
|
- **Live Preview**: The built-in development server allows you to preview your documentation as you write it. It even auto-reloads and refreshes your browser whenever you save changes.
|
|
- **Deploy Anywhere**: MkDocs builds completely static HTML sites that can be hosted on GitHub Pages, Amazon S3, or any other hosting platform of your choice. |