Nim-markdown 是一个由 Nim 所编写的 Markdown 解析器。
特性
- 支持 Commonmark
- 缩进的代码块
- Block 引用
- 有序/无序列表
- 嵌套列表
- 表
- 内联链接
- 图片链接
- 双重强调
- 删除线
- 内联代码
- 内联 HTML
- 转义
- ……
安装
通过nimble在你的项目根目录中安装
$ nimble install markdown # or with current stable version $ nimble install markdown@">= 0.8.0" # or with the latest version $ nimble install markdown@#head
库的使用
以下是markdown用作库的最小用法。
# 1. import pkg. import markdown # 2. transform md to html. let html = markdown("# Hello World\nHappy writing Markdown document!") # 3. do something :) echo(html)
- API 文档：https : //www.soasme.com/nim-markdown/htmldocs/markdown.html
- 开发指南：https : //enqueuezero.com/markdown-parser.html
- 备忘单：https : //github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
二进制用法
binarymarkdown 的用法如下：
# Read from stdin and write to stdout.
$ markdown < README.md > README.html
开发
构建：
$ nimble build
测试模块：
$ nimble test
构建文档：
$ nim doc --project --git.url=https://github.com/soasme/nim-markdown --git.commit=v0.7.0 src/markdown.nim
