mdx_sections 0.1

概述

此模块是Python-Markdown的扩展，它提供了向Markdown文档添加少量结构的能力。

此扩展的操作基于两个前提

• 每个标题元素表示新文档部分的开始。

• 文档部分可以是嵌套的，文档部分的父级是第一个 preceding heading element with a higher order 创建的部分，例如一个 h2 部分包含在它之前出现的对应于 h1 的标题块中。如果没有这样的元素，则它是根元素的子元素。

新部分（包含 div 元素）可以配置为具有特定的 id 和 class 属性。语法是

# {id,class} Title

id 和 class 都是可选的，只要启用此扩展，就会创建包含 div 元素。

以下是一个示例。假设提供以下输入文档

# {resume} Resumé

## {education} Education
Educational experience

## {experience} Working Experience
Work experience

### {xyz_corp,employer} XYZ Corp.
I worked at XYZ

### {acme_inc,employer} Acme Inc.
I also worked at Acme

## Hobbies
- Cards
- Books
- Dogs

### About _my_ hobbies
My hobbies are great.

这将转换为以下内容

<div class="section" id="section_resume">
  <h1 class="title">Resum&eacute;</h1>
  <div class="section" id="section_education">
    <h2 class="title">Education</h2>
    <p>Educational experience</p>
  </div>
  <div class="section" id="section_experience">
    <h2 class="title">Working Experience</h2>
    <p>Work experience</p>
    <div class="employer" id="section_xyz_corp">
      <h3 class="title">XYZ Corp.</h3>
      <p>I worked at XYZ</p>
    </div>
    <div class="employer" id="section_acme_inc">
      <h3 class="title">Acme Inc.</h3>
      <p>I also worked at Acme</p>
    </div>
  </div>
  <div class="section">
    <h2 class="title">Hobbies</h2>
    <ul>
      <li>Cards</li>
      <li>Books</li>
      <li>Dogs</li>
    </ul>
    <div class="section">
      <h3 class="title">About <em>my</em> hobbies</h3>
      <p>My hobbies are great.</p>
    </div>
  </div>
</div>

在我看来，生成的文档在语义上是正确的。它也更容易用CSS进行样式化。

安装

使用setuptools安装，例如（在虚拟环境内）

$ pip install mdx_sections

或者如果您喜欢从Github获取最新版本

$ git clone git://github.com/jessedhillon/mdx_sections.git

用法

有关Python-Markdown扩展的详细介绍，请参阅文档http://freewisdom.org/projects/python-markdown/Extensions。

此扩展可通过简短名称sections访问，并且它有两个配置参数

• section_cls，默认为section。这是在Markdown文档未指定时应用于生成的div的默认CSS类。

• heading_cls，默认为title。这是应用于正在转换的h[1-6]元素的默认CSS类。