【问题标题】:Is there a way to add some basic scripting to MkDocs when writing in MarkDown?在 MarkDown 中编写时,有没有办法向 MkDocs 添加一些基本脚本?
【发布时间】:2021-11-15 08:08:50
【问题描述】:

我有一个使用 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 模板的信息,想知道是否可以使用它来实现此目的?

【问题讨论】:

    标签: css templates jinja2 markdown mkdocs


    【解决方案1】:

    您可能希望使用metadata 也称为frontend 数据,如yaml-style-meta-data section 中所述。此类信息放置在您的降价文件的开头。然后可以使用内容来生成内容。

    macro 插件就是为此而设计的,可以在这里找到https://mkdocs-macros-plugin.readthedocs.io

    【讨论】:

      猜你喜欢
      • 2023-03-26
      • 2023-03-16
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2020-10-09
      • 2014-11-29
      • 1970-01-01
      相关资源
      最近更新 更多