mkdocs生成项目文档

简介: mkdocs生成项目文档

安装


pip install mkdocs

创建项目


mkdocs new my-project
cd my-project

项目目录


.

├── docs
│   └── index.md
├── mkdocs.yml

运行服务


$ mkdocs serve

http://127.0.0.1:8000/


文档生成


mkdocs build
mkdocs build --clean

部署到github


# 先推到master分支
echo "site/" >> .gitignore
git init
git add . 
git commit -m "add"
git push
# 再进行部署
mkdocs gh-deploy

一个不错的主题


pip install mkdocs-material

mkdocs.yml配置示例


site_name: 项目文档
nav:
    - 主页: index.md
    - 关于: about.md
theme:
  name: 'material'
  language: 'zh'
extra:
  social:
    - type: 'github'
      link: 'https://github.com/mouday'

相关文章
|
9月前
|
自然语言处理 算法 前端开发
C++与Doxygen:精通代码文档化之道
C++与Doxygen:精通代码文档化之道
627 0
|
Java 数据安全/隐私保护
在线预览项目kkFileView(二)代码讲解与修改
在线预览项目kkFileView(二)代码讲解与修改
992 0
在线预览项目kkFileView(二)代码讲解与修改
|
5月前
|
自然语言处理 JavaScript 网络协议
简单使用vitepress快速搭建一个文档网站
VitePress 是一个静态站点生成器 (SSG),类似的项目有docsify、VuePress、hexo。用 Markdown 编写的内容生成可以轻松部署到任何地方的静态 HTML 页。
102 9
|
7月前
vscode 生成项目目录结构 directory-tree 实用教程
vscode 生成项目目录结构 directory-tree 实用教程
472 2
给项目写README文档
给项目写README文档
100 0
Hexo、Jekyll、Sphinx、mkdocs、docsify等静态博文档汇总
Hexo、Jekyll、Sphinx、mkdocs、docsify等静态博文档汇总
263 0
Hexo、Jekyll、Sphinx、mkdocs、docsify等静态博文档汇总
|
机器人
gitbook 插件 阅读更多
gitbook 插件 阅读更多
|
存储 缓存 开发工具
DVC 使用指南:项目结构中.dvcignore文件详解
.dvcignore 文件标记在遍历 DVC 项目时应排除哪些文件和目录。有时您可能希望 DVC 在处理项目时忽略某些文件。 例如,在工作区目录中处理大量数据文件时,对于dvc status这样简单的操作,您可能会遇到执行时间延长的问题。 在其他情况下,您可能
类似GitBook的文档构建工具
类似GitBook的文档构建工具
1581 0
类似GitBook的文档构建工具
|
应用服务中间件 区块链 nginx
MkDocs | 超简单的文档生成器
MkDocs | 超简单的文档生成器
695 0