跳转到主要内容

markdown中的属性

项目描述

anchor_txt:markdown中的属性

anchor_txt增加了在markdown文件中嵌入属性的能力,以便外部工具可以更容易地将它们链接到彼此和代码,并执行其他操作。

使用anchor_txt.Section.from_md_path来加载markdown文件。

## Markdown语法 anchor_txt属性的语法很简单。

  • 形式为# header {#anchor}的标题将提取并可用在Header.anchor

  • 一个标题创建一个部分,该部分可以具有子 部分

  • 部分具有属性,这些属性是嵌入的yaml,可以是内联的或是在以下所示的代码块中。

内联属性看起来像以下之一:` `@{foo}` `@{bar: 2}` `

代码块属性看起来如下。它们必须包含标识符yaml(或json)并以@结尾

`yaml @ foo: null bar: 2 `

部分内的属性块通过与dict.update相同的进程合并,但是重叠的键将引发错误。

## 开发者运行 make init 创建必要的虚拟环境

运行 make test 进行基本测试或 make check 进行lints和格式化。

## 许可证

源代码在以下任一许可证下获得许可:

由您选择。

除非您明确说明,否则根据Apache-2.0许可证定义,您有意提交以包含在作品中的任何贡献,将按上述方式双重许可,不附加任何其他条款或条件。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

anchor_txt-0.1.6.tar.gz (8.0 kB 查看哈希值

上传时间

支持者