markdata 0.4.1

：感叹号：markdata需要python>；=3.6.0。：感叹号：

$ pip install markdata

用法

作为库

importmarkdatadefmy_directive():passmarkdown=markdata.markdata(# A string or file-like object.file_or_str,# A dictionary of custom directives (optional).## Format: {'name': my_directive}.directives={},# The type of front matter to parse (optional).fm_format=None,# 'JSON', 'YAML', or 'TOML'# The directory that paths will be resolved relative to (optional).root=None)

从命令行

$ markdata --help
Usage: markdata [OPTIONS] SOURCE [DESTINATION]  A flavor-agnostic extension framework for Markdown.  Reads from <SOURCE> and writes to <DESTINATION>.  If <SOURCE> is a single file, it will be converted to Markdown and written  to <DESTINATION> (default: stdout).  If <SOURCE> is a directory, all child Markdata files will be converted to  Markdown and written to <DESTINATION> (default: overwrite <SOURCE>).Options:  --fm-type [JSON|YAML|TOML]  The type of front matter to parse.  --root PATH                 The directory that paths will be resolved                              relative to.  --directives PATH           The directory containing your custom directives.  --version                   Show the version and exit.  --help                      Show this message and exit.

指令

markdata的功能由指令驱动，这些指令是调用python函数的标记片段。指令可以通过两种方式定义：

# Example directives

<!-- This is a "block" directive -->

```callout{'title': 'NOTE', 'classes': ['warning']}
This is a callout message.
```

<!-- This is an "inline" directive -->

`table{'path': '../data/table.yml', 'classes': ['table'], 'caption': 'My data'}`

table指令从yaml、json或csv文件创建一个html表（带有可选的标题和类）。在此文件上调用markdata后，输出将是如下行的内容：

<tableclass="table"><caption>My data</caption><thead><!-- headers --></thead><tbody><!-- rows --></tbody></table>

内置指令

markdata有两个内置的通用指令：

deftable(path:str,classes:List[str]=[],caption:str="")->str:"""Return an HTML table built from structured data (CSV, JSON, or YAML).    `path` [required]: A path (relative to the directive-containing file) to a           CSV, JSON, or YAML file.    `classes` [optional]: A list of HTML classes to apply to the table.    `caption` [optional]: A caption for the table.    Example:        `table{'path': 'table.yml', 'classes': ['table'], 'caption': '...'}`    """