有没有办法在用 MarkDown 编写时向 MkDocs 添加一些基本脚本？

Question

我有一个使用 MkDocs 的文档站点。它包含一个文档列表，所有文档都具有相同的基本结构（我们只有一个实验笔记本列表）。每个笔记本（写在一个单独的 MarkDown 文件中）应该在开头使用以下内容包含作者 + 日期：

<style>table, td, th {border:none!important; font-size:15px}</style>

|                |                             |
| -------------- | :-------------------------- |
| **Author(s):** | First Author, Second Author |
| **Date:**      | 2024-01-23                  |

我想要的是某种模板，使用户能够避免添加上述行（例如，避免添加 CSS），而只是指定作者列表和日期。这将使我作为文档所有者能够在以后需要时更改格式，而无需更改每个 .md 文件内容。

我阅读了有关 Jinja 模板的信息，想知道是否可以使用它来实现这一目标？

Answer 1

您可能想要使用 metadata 也称为 frontend 的数据，如 yaml-style-meta-data section 中所述。此类信息位于降价文件的开头。然后可以使用内容生成内容。

macro 插件就是为此制作的，可以在这里找到 https://mkdocs-macros-plugin.readthedocs.io

有没有办法在用 MarkDown 编写时向 MkDocs 添加一些基本脚本？

Is there a way to add some basic scripting to MkDocs when writing in MarkDown?

css

markdown

templates

jinja2

mkdocs