使用 mkdocs 获取自动附加片段

Question

刚刚发现 mkdocs 并且非常喜欢它。我目前正在将在专有工具中完成的在线移植到其中。

我遇到的唯一障碍是实现自动附加 sn-ps。

我能够按照此处所述实现缩写：

https://squidfunk.github.io/mkdocs-material/reference/abbreviations/

我的下一步是添加该页面上描述的词汇表，方法是将这些缩写词移动到同一页面上描述的 sn-ps 文件中。

但我不必手动将 sn-ps 添加到项目中的每个 Markdown 文件中，而是想使用此处所述的自动附加：

https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

我的 mkdocs.yml 文件声明其主题和扩展名如下：

theme:
    name: material 
markdown_extensions:
  - attr_list
  - abbr
  - pymdownx.snippets

但是，我不清楚我究竟在哪里配置了“auto_append”、“base_path”以及后一个文档中提到的其他选项。如果有人有工作示例，我将不胜感激。

Answer 1

在您的mkdocs.yml 文件中指定markdown_extensions 的位置提供了sn-p 选项，例如

# mkdocs.yml
...

markdown_extensions:
  - pymdownx.snippets:
      # Fails the build if any imports are missing
      check_paths: true
      auto_append: []
      base_paths: ["."]

希望这会有所帮助！