跳转至

欢迎使用文档站

这是 MkDocs Material 文档站,通过 Markdown 编写内容。

快速开始

所有文档都在服务器 /newdata/mkdocs/docs/ 目录下,是普通的 Markdown 文件:

/newdata/mkdocs/
├── mkdocs.yml      # 站点配置(主题/导航/插件)
├── docs/           # Markdown 文档目录
│   └── index.md    # 首页
└── site/           # 构建产物(自动生成,不用手动改)

写作示例

支持代码高亮:

def hello():
    print("Hello, MkDocs!")

支持提示框:

提示

这是一个提示框

注意

这是一个警告框

支持表格:

功能 状态
代码高亮 ✅
搜索 ✅
深色模式 ✅

修改后如何更新?

在服务器上执行构建命令即可(见部署说明),页面立即更新。