mkdocs
排除文件
https://github.com/apenwarr/mkdocs-exclude
嵌入页面
<iframe
src="http://localhost:5001"
width="100%"
height="800"
frameborder="0">
</iframe>
加密
pip install mkdocs-encryptcontent-plugin
site_name: My Docs
theme:
name: material
plugins:
- search
- encryptcontent:
title_prefix: "🔒 "
summary: "此页面已加密"
placeholder: "请输入密码"
decryption_failure_message: "密码错误"
encryption_info_message: "🔐 本页面内容已加密"
---
encrypt: true
password: mypassword
---
# 这是一个加密页面
只有输入正确密码才能看到
主题
mkdocs-material
python -m pip install mkdocs-material
theme:
name: material
markdown_extensions:
- admonition
- pymdownx.details
theme:
features:
- content.tabs.link
=== "C"
``` c
#include <stdio.h>
int main(void) {
printf("Hello world!\n");
return 0;
}
```
=== "C++"
``` c++
#include <iostream>
int main(void) {
std::cout << "Hello world!" << std::endl;
return 0;
}
```
插件
每个目录下创建.pages 文件定义nav
Note
启用 awesome-pages 插件后,请确保 mkdocs.yml 文件中没有定义 nav 配置，两者同时存在可能引发冲突
plugins:
- awesome-pages
打开新页面
[页面](地址){ target="_blank" }
plugins:
- privacy:
links_attr_map:
target: _blank
grid
<div class="grid cards" markdown>
- :fontawesome-brands-html5: [__EasyBD__](https://easybd.tools.catpd.cn) excel json 互转换工具
- :fontawesome-brands-html5: [__EasyBD__](https://easybd.tools.catpd.cn) excel json 互转换工具
</div>
引用
pip install pymdown-extensions
markdown_extensions:
- pymdownx.snippets:
base_path:
- docs
check_paths: false # 可选，根据需要启用
Note
注意使用全路径
--8<-- "includes/other-file.md"
\--8<--
引用内容1
引用内2
\--8<--
引用内容
--8<-- [xx.md:name]
nginx 配置
root /home/wjn/me;
index index.html;
location / {
try_files $uri $uri/ /index.html;
}