*非常简单的标记格式
dumbdown的Python项目详细描述
简化
极为简化的准标记到HTML解析,在JavaScript和Python中都有。
安装
要安装python包:
pip install dumbdown
要安装npm包:
npm install dumbdown
演示
要查看演示:克隆此repo,请从package.json
安装节点模块,然后在您喜爱的浏览器中打开demo.html
。尝试键入一些带有*和\字符的文本。
用法
它允许3种格式标记,bold,italic和>;块引号,但它使用slack的语法而不是标记语法。
粗体文本必须有*
环绕:
For example, *this would be bold*.
斜体文本周围有_
:
And _this would be in italics_.
粗体和斜体可以相互嵌套:
*bold _bold-italics_*, _italics with some *bold* inside_. *_Nice!_*.
块引号是以>
:
> this is a blockquote
> woo
python api
python版本提供了两个函数:to_html
和to_plain
。
>>>fromdumbdownimportto_html,to_plain>>>to_html("*This is bold _this is bold ital._*\nThis is on a new line")'<p><strong>This is bold <i>this is bold ital.</i></strong></p><p>This is on a new line</p>'>>>to_plain("*This is bold _this is bold ital._*\nThis is on a new line")'This is bold this is bold ital. This is on a new line'
javascript api
javascript版本提供了两个函数:toHtml
和toPlain
。
>>>import{toHtml,toPlain}from"dumbdown";>>>toHtml("*This is bold _this is bold ital._*\nThis is on a new line");'<p><strong>This is bold <i>this is bold ital.</i></strong></p><p>This is on a new line</p>'>>>toPlain("*This is bold _this is bold ital._*\nThis is on a new line")'This is bold this is bold ital. This is on a new line'
测试
测试:
Python
pytest
javascript
yarn run test
释放
python/pypi
建造
python setup.py sdist bdist_wheel
释放
twine upload dist/*
javascript/npm
建造
yarn run build
释放
npm publish