Regdown

Regdown是一个Python-Markdown扩展，用于交互式法规文本。

• 依赖项
• 安装
• 文档
• 获取帮助
• 参与其中
• 许可
• 致谢和引用

依赖项

• Python 3.6, 3.8
• Python-Markdown 3.2

安装

首先，安装Regdown

pip install regdown

然后你可以

• 在调用markdown时指定Regdown作为扩展

  import markdown
  from regdown import RegulationsExtension
  
  markdown.markdown(text, extensions=[RegulationsExtension()],)
  

• 使用方便的regdown函数以RegulationsExtension渲染Markdown

  from regdown import regdown
  
  regdown(text)
  

文档

Regdown为Markdown添加了三个主要功能，以支持使联邦法规更容易导航和阅读。

带标签的段落

{label} 段落文本

每个段落都可以有一个定义的标签，使用段落开头的{label}语法。这被转换为结果HTML段落元素的id属性。如果没有给出标签，段落的内容将被散列以生成该段落的唯一id。这使得文本中的任何段落都可以直接链接。

伪表单

• 表单字段：__
• __表单字段
• 行内__字段__

示例打印表单，其中 \_\_ 表示手写输入的空位。可以在2到50个下划线之间。

章节符号

§ 1024.5(d) §1024.5(d)

章节符号将在其后面插入非断行空格 ( )，以避免符号悬挂在行尾。

块引用

see(label)

将标签段落的文本插入其他 Regdown 文档的行内到当前文档中。

引用可以放在段落前后。这些引用是到其他 Markdown 文档中标记的段落。如果提供了 contents_resolver 回调和 url_resolver 回调，可以查找并插入行内文档中的其他段落文本。如果提供了 render_block_reference 回调，可以执行对引用文本的HTML自定义渲染。

回调

• contents_resolver(label): 解析段落标签并返回该段落的Markdown内容（如果段落存在）。
• url_resolver(label): 解析段落标签并返回该段落的一个URL（如果段落存在）。
• render_block_reference(contents, url=None): 将块引用的内容渲染为HTML。如果提供了 url_resolver，可以将引用的URL作为关键字参数提供。

from regdown import regdown

def my_contents_resolver(label):
    # Lookup the document that contains the given label …
    return corresponding_markdown_text

def my_block_renderer(block_markdown_contents, url=None):
    # Render the block to HTML
    return block_html

regdown(
    text,
    contents_resolver=my_contents_resolver,
    render_block_reference=my_block_renderer
)

获取帮助

请将问题添加到 问题跟踪器。

参与其中

有关 如何 贡献的一般说明可以在 CONTRIBUTING 中找到。

许可

1. 条款
2. 许可证
3. CFPB源代码政策

致谢和引用

regdown是从 Wagtail-Flags 分支出来的，而Wagtail-Flags又是从 consumerfinance.gov 分支出来的。