Linux command
mkdocs 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
Create new project
mkdocs new [project-name]
Serve locally
mkdocs serve
Build site
mkdocs build
Deploy to GitHub Pages
mkdocs gh-deploy
Serve on custom port
mkdocs serve -a [localhost:8080]
Strict mode
mkdocs build --strict
说明
mkdocs generates documentation websites. It builds static sites from Markdown files. The tool is designed for project documentation. Supports themes and plugins.
参数
- new _NAME_
- Create new project.
- serve
- Start dev server.
- build
- Build static site.
- gh-deploy
- Deploy to GitHub Pages.
- -a _ADDR_
- Server address.
- --help
- Display help information.
FAQ
What is the mkdocs command used for?
mkdocs generates documentation websites. It builds static sites from Markdown files. The tool is designed for project documentation. Supports themes and plugins.
How do I run a basic mkdocs example?
Run `mkdocs new [project-name]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does new _NAME_ do in mkdocs?
Create new project.