Skip to content

如何使用Mkdocs

MKDocs Manual

For full documentation visit mkdocs.org.
Get started visit getting-started
中文文档

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

美化和多功能


代码高亮的方法: 快来美化你的MKDocs吧
修改字体: 尝试修改 mkdocs-material 网页的字体的过程记录
优美的参考: 鹤翔万里的笔记本
优美的参考: RonaldLN的笔记本,在Configure & Debug有一些关于mkdocs的内容
对LaTeX的支持: MathJax and KaTeX for MKDocs
左侧导航栏设置：导航设置

提示块实现 

!!! tldr "写在前面"
    感谢xxx中提供的安装方法，本文主要是根据他的博客实现的。

写在前面

感谢xxx中提供的安装方法，本文主要是根据他的博客实现的。

Use tip for this.

This is a tip.

Use info for this.

This is a piece of information, or you can use todo.

Use question for this.

This is a question.

Use warning for this.

This is a warning

Use danger for this.

This alerts danger!

Use success for this.

This alerts success


引用标注的实现 

> TLDR means too long, didn't read

TLDR means too long, didn't read

markdown 基本语法

不同等级标题，斜体，加粗，删除线，链接，图片，表格

流程图

基于mermaid方法的流程图

Project layout

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