mkdocs 使用说明

安装

pip3 install mkdocs==1.4.2

创建项目

mkdocs new my-project
cd my-project

修改 mkdocs.yml

site_name: My Docssite_url: https://example.com/nav:- Home: index.md- 测试: 测试.mdtheme: readthedocsextra:version: 1.0

运行

mkdocs serve

访问

http://127.0.0.1:8000

支持中文搜索

修改搜索文件

D:\Python37\Lib\site-packages\mkdocs\contrib\search\search_index.py

替换 lunr.js

下载 https://raw.githubusercontent.com/codepiano/lunr.js/master/lunr.min.js
重命名 为 lunr.js 覆盖
D:\Python37\Lib\site-packages\mkdocs\contrib\search\templates\search\lunr.js

具体说明参考

编译成静态文件

mkdocs build

mkdocs 使用说明相关推荐

abaqus高性能服务器怎么用,高性能计算平台ABAQUS任务调度使用说明作者陈林E-Mailchenlin.PDF...
高性能计算平台ABAQUS任务调度使用说明作者陈林E-Mailchenlin.PDF 高性能计算平台ABAQUS 任务调度使用说明作者:陈林 E-Mail:chenlin@ 日期:2017-1-10 ...
linux 文件拷贝并替换,Linux_cmd replace 文件替换使用说明，帮助信息：复制代码代码如 - phpStudy...
cmd replace 文件替换使用说明帮助信息: 复制代码代码如下: 替换文件. REPLACE [drive1:][path1]filename [drive2:][path2] [/A] [ ...
使用 mkdocs 搭建个人 wiki 站点
原文: https://rebootcat.com/2020/09/20/wiki/ why wiki 博客通常是用来记录一些完整的文章,每篇文章有一个主题.但是我想把平日里的一些笔记也记录到我的博客 ...
Simple Dynamic Strings(SDS)源码解析和使用说明二
在<Simple Dynamic Strings(SDS)源码解析和使用说明一>文中,我们分析了SDS库中数据的基本结构和创建.释放等方法.本文将介绍其一些其他方法及实现.(转载请指明出于 ...
Delphi开发的IOCP测试Demo以及使用说明。
Delphi开发的IOCP,此为压力测试Demo和使用说明.
oracle database link mysql_oracle database link使用说明
oracle database link使用说明作用: 将多个oracle数据库逻辑上看成一个数据库,也就是说在一个数据库中可以操作另一个数据库中的对象. 简易语法: CREATE [PUBLIC] ...
序列拼接工具Bowtie使用说明
序列拼接工具Bowtie使用说明 2011-06-08 ~ ADMIN Bowtie是一个超级快速的,较为节省内存的短序列拼接至模板基因组的工具.它在拼接35碱基长度的序列时,可以达到每小时2.5亿次 ...
benchmarksql测试mysql_数据库压力测试工具 -- BenchmarkSQL 使用说明
关于数据库的压力测试,之前写过3篇Blog: 数据库基准测试(Database Benchmarking) 说明数据库压力测试工具 -- Hammerdb 使用说明数据库压力测试工具 -- Swi ...
计算机网页基础课专业,关于《计算机应用基础》课程网页下的学习资源使用说明....
关于<计算机应用基础>课程网页下的学习资源使用说明. 关于<计算机应用基础>课程网页下的学习资源使用说明各位同学:大家好! 07春学期已接近一半的时间了,新生对课程还需要更多 ...

mkdocs 使用说明

mkdocs 使用说明

安装

创建项目

修改 mkdocs.yml

运行

访问

支持中文搜索

编译成静态文件

mkdocs 使用说明相关推荐

最新文章

热门文章