mkdocs 生成帮助文档
2024-10-13 11:38:48
简介
MkDocs 可以同时编译多个markdown文件,形成书籍一样的文件。有多种主题供你选择,很适合项目使用。
MkDocs 是快速,简单和华丽的静态网站生成器,可以构建项目文档。文档源文件在 Markdown 编写,使用单个 YAML 配置文件配置。
官方快速开始
https://squidfunk.github.io/mkdocs-material/getting-started/
本人整理的快速开始
首先安装python // 安装
pip install mkdocs // 安装后查看一下版本: mkdocs --version // 初始化一个项目
mkdocs new myproject cd myproject // 启动
mkdocs serve
// 升级
pip install -U mkdocs // 卸载
pip uninstall mkdocs
中文帮助文档
https://markdown-docs-zh.readthedocs.io/zh_CN/latest/
源码
git clone https://github.com/squidfunk/mkdocs-material.git
启动
mkdocs serve
配置:mkdocs.yml
# Page tree
nav:
- aaaaaa:
- aaaaaa.: aaaaaa..md
- aaaaaa.: aaaaaa..md
- bbbbbb:
- bbbbbb.:
- bbbbbb.1.1:
- bbbbbb.1.1.: bbbbbb.1.1..md
- bbbbbb.: bbbbbb..md
- aaaaaa: aaaaaa.md
- cccccc: cccccc.md
打包成静态到 /site 目录
mkdocs build --clean
/doc // markdown 文件,也是文章列表数据文件
/material // 主程序
/site // 打包后的静态文件
mkdocs.yml // 主要的配置文件
...
https://www.cnblogs.com/simonid/p/6354034.html
最新文章
- 遗传算法在JobShop中的应用研究(part 5:解码)
- Sharepoint 2010 工作流启动时处理出错
- python的re正则表达式模块学习
- 1.2---翻转字符串(CC150)
- [SQL]查询及删除重复记录的SQL语句
- visualsvn server 安装提示无法启动
- 左侧菜单 z
- Servlet实现表单提交(MyEclipse10,Tomcat7.0,JDK1.7,)——Java Web练习(一)
- oracle几个函数整理 DECODE() NVL NVL2 NULLIF Coalesce(转)
- 关于MTK平台SIM-ME Lock的配置方案
- springmvc中的page
- HTML转义字符串
- 询问Spring Bott和高并发框架两个问题
- Github 上 Star 最多的个人 Spring Boot 开源学习项目
- web实验博客3.css-position
- vue+vue-router+vuex实战
- web-worker 的使用
- HDU 4324 Triangle LOVE (拓扑排序)
- 【ASP.NET】ASP.NET中权限验证使用OnAuthorization实现
- JSTL自定义函数完成ACL即时认证
热门文章
- 自学Python4.7-生成器(方式一:生成器函数)
- android设置透明度代码片段
- luogu1608 路径统计 (spfa)
- HDU6333 Harvest of Apples (杭电多校4B)
- 洛谷 P3121 【[USACO15FEB]审查(黄金)Censoring (Gold)】
- 2019 校内赛 RPG的地牢猎手(bfs+优先队列)
- 如何优雅的解决mac安装zsh不执行.bash_profile
- angular与vue的应用对比
- Spring的核心
- Vue+Django2.0 restframework打造前后端分离的生鲜电商项目(2)