Skip to content

MkDocs DOC

安装

pip install mkdocs

常用命令

  • mkdocs new [dir-name] - 创建一个新项目。
  • mkdocs serve -a 127.0.0.1:8080 - 启动 Mkdocs 服务。
  • mkdocs build - 构建静态页面至 /site 目录下。
  • mkdocs -h - 帮助信息。
  • mv x.md blog/docs/ - 添加新页面。

配置文件

site_name: Mksite #必要配置
site_url: https://xvuln.com/ #必要配置

For full documentation visit mkdocs.org.

favicon.ico 在 img 目录下创建子目录 docs 并将自定义 favicon.ico 文件复制到目录中即可。

site_name: Mksite #必要配置
site_url: https://xvuln.com/ #必要配置
# 可选配置👇
nav:
# 必须与 docs 目录下文档相关
    - Home: index.md #导航栏
    - About: about.md #导航栏
    - '帮助': 'help.md' #导航栏命名
    - 'hacktricks': 'https://book.hacktricks.xyz' #指向外部站点的导航栏

theme: 
  name: readthedocs #主题设置
repo_url: https://github.com/ovuln/ovuln.github.io/ #在每个页面添加此存储库地址
edit_uri: '?query=root/path/docs/'

主题

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.