有一个 Markdown 模板吗?

问题描述 投票:0回答:1

我有一个知识内容需要存储在 github 存储库中。内容约为 40 个文件(目前为 40 个 docx)。它们几乎都是一页文件。它们有一个共同的结构:

问题

一些简介

选项

一些简介

推荐

一些简介

如果我写下 40 个 md 文件(复制/粘贴结构并填写简介),我可能会冒着稍后处理需要稍作更改的结构问题的风险 - 例如将“推荐”重命名为“解决方案”,或其他一些格式细节。仅仅为了格式化我就得接触 40 个文件。

一定有更好的方法。

例如,有没有一种方法可以在一个地方定义md文件的模板,然后创建40个md文件来保存内容,但不一定要格式化。然后有一些东西可以使用模板渲染这些文件吗?

templates markdown github-flavored-markdown
1个回答
0
投票

我冒着稍后处理需要稍微改变的结构问题的风险 - 例如将“推荐”重命名为“解决方案”,或一些其他格式细节。仅仅为了格式化我就得接触 40 个文件。

您始终需要为数据选择某种结构。

模板的思想是将表示与数据分离。任何模板解决方案都需要从某种数据格式(例如 JSON)读取其数据,并且您还必须定义键名。是否有:

  1. JSON 字段
    "recommendation":
    ,
  2. 降价标题
    ## Recommendation
    ,或
  3. HTML 标题
    <h2>Recommendation</h2>

没关系。在所有三种格式中,您都需要选择字段名称(在本例中为推荐)并定义结构(即使您不使用模式或验证器强制执行它,该结构仍然存在以使数据有用)。在所有三种情况下,您都可以稍后编写脚本来自动更改字段或标题的名称。

因此我认为,除了已有的 markdown 文件之外,你确实不会获得任何好处。

© www.soinside.com 2019 - 2024. All rights reserved.