mkdocs安装速记

最新推荐文章于 2025-06-01 09:16:53 发布

原创最新推荐文章于 2025-06-01 09:16:53 发布 · 421 阅读

0 ·

CC 4.0 BY-SA版权

学与玩专栏收录该内容

92 篇文章

订阅专栏

MkDocs是一款高效、简洁且美观的静态站点生成器，专为项目文档构建而设计。它使用Markdown作为源文件格式，并通过单一的YAML配置文件进行设置。生成的完全静态HTML站点可在GitHub Pages、Amazon S3或其他任意主机上托管。MkDocs提供了多种主题选择，包括内置的mkdocs和readthedocs主题，以及第三方提供的主题。开发过程中，内建的开发服务器允许实时预览文档，保存更改时会自动刷新浏览器。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Overview

MkDocs is a fast, simple and downright gorgeous static site generator
that’s geared towards building project documentation. Documentation
source files are written in Markdown, and configured with a single
YAML configuration file.

Host anywhere

MkDocs builds completely static HTML sites that you can host on GitHub
pages, Amazon S3, or anywhere else you choose.

Great themes available

There’s a stack of good looking themes available for MkDocs. Choose
between the built in themes: mkdocs and readthedocs, select one of the
3rd party themes in the MkDocs wiki, or build your own.

Preview your site as you work

The built-in dev-server allows you to preview your documentation as
you’re writing it. It will even auto-reload and refresh your browser
whenever you save your changes.

Easy to customize

Get your project documentation looking just the way you want it by
customizing the theme.

pip install --upgrade pip
pip install mkdocs
pip install click-man

然后在需要放置文档的位置打开命令行窗口

mkdocs new project_name
cd project_name
mkdocs serve

然后访问http://127.0.0.1:8000/ 就可以看到生成的页面