prettymd
--------
A tool that formats markdown text in Chinese.
Install
-------
- 从 pypi 安装
```shell
pip install prettymd
```
Features
--------
- 在中英文之间添加空格
```shell
$ python -m prettymd "我是中文nihao呀"
我是中文 nihao 呀
```
- 将英文变为代码风格。指定 style = 'code'，将英文用反引号包裹起来
```shell
$ python -m prettymd "我是中文nihao呀" -s code
我是中文 `nihao` 呀
```
- 从文件读取内容
```shell
$ cat .\tests\testfile.md
摘要算法就是通过摘要函数f()对任意长度的数据data计算出固定长度的摘要digest，目的是为了发现原始数据是否被人篡改过。
$ python -m prettymd -f .\tests\testfile.md
摘要算法就是通过摘要函数 f() 对任意长度的数据 data 计算出固定长度的摘要 digest，目的是为了发现原始数据是否被人篡改过。
```
- 输出到指定文件
```shell
$ # -o 指定输出文件路径
$ python -m prettymd -f .\tests\testfile.md -o testfile.md
$ cat testfile.md
摘要算法就是通过摘要函数 f() 对任意长度的数据 data 计算出固定长度的摘要 digest，目的是为了发现原始数据是否被人篡改过。
```
- 代码调用
```python
>>> from prettymd import format
>>> format('这是一个示例rst文档')
'这是一个实例 rst 文档'
>>> from prettymd import format
>>> format('这是一个示例rst文档', style='code')
'这是一个实例 `rst` 文档'
>>> # 为标题添加索引
>>> from prettymd import format
>>> print(format("""
## h2
### h3
## h22
#### h4
"""))
## 1. h2
### 1.1. h3
## 2. h22
#### 2.0.1. h4
```
Raw data
{
"_id": null,
"home_page": "https://github.com/kingronjan/prettymd",
"name": "prettymd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "prettymd",
"author": "kingron",
"author_email": "kingronjan@qq.com",
"download_url": "https://files.pythonhosted.org/packages/81/cd/07563727ff5e45445fdc03893a43771cef5b00341a4a7758058da84b2997/prettymd-0.1.111.tar.gz",
"platform": null,
"description": "prettymd\r\n--------\r\n\r\n\r\nA tool that formats markdown text in Chinese.\r\n\r\n\r\nInstall\r\n-------\r\n\r\n- \u4ece pypi \u5b89\u88c5\r\n ```shell\r\n pip install prettymd\r\n ```\r\n\r\n\r\nFeatures\r\n--------\r\n\r\n\r\n- \u5728\u4e2d\u82f1\u6587\u4e4b\u95f4\u6dfb\u52a0\u7a7a\u683c\r\n ```shell\r\n $ python -m prettymd \"\u6211\u662f\u4e2d\u6587nihao\u5440\"\r\n \u6211\u662f\u4e2d\u6587 nihao \u5440\r\n ```\r\n\r\n- \u5c06\u82f1\u6587\u53d8\u4e3a\u4ee3\u7801\u98ce\u683c\u3002\u6307\u5b9a style = 'code'\uff0c\u5c06\u82f1\u6587\u7528\u53cd\u5f15\u53f7\u5305\u88f9\u8d77\u6765\r\n ```shell\r\n $ python -m prettymd \"\u6211\u662f\u4e2d\u6587nihao\u5440\" -s code\r\n \u6211\u662f\u4e2d\u6587 `nihao` \u5440\r\n ```\r\n\r\n- \u4ece\u6587\u4ef6\u8bfb\u53d6\u5185\u5bb9\r\n ```shell\r\n $ cat .\\tests\\testfile.md\r\n \u6458\u8981\u7b97\u6cd5\u5c31\u662f\u901a\u8fc7\u6458\u8981\u51fd\u6570f()\u5bf9\u4efb\u610f\u957f\u5ea6\u7684\u6570\u636edata\u8ba1\u7b97\u51fa\u56fa\u5b9a\u957f\u5ea6\u7684\u6458\u8981digest\uff0c\u76ee\u7684\u662f\u4e3a\u4e86\u53d1\u73b0\u539f\u59cb\u6570\u636e\u662f\u5426\u88ab\u4eba\u7be1\u6539\u8fc7\u3002\r\n\r\n $ python -m prettymd -f .\\tests\\testfile.md\r\n \u6458\u8981\u7b97\u6cd5\u5c31\u662f\u901a\u8fc7\u6458\u8981\u51fd\u6570 f() \u5bf9\u4efb\u610f\u957f\u5ea6\u7684\u6570\u636e data \u8ba1\u7b97\u51fa\u56fa\u5b9a\u957f\u5ea6\u7684\u6458\u8981 digest\uff0c\u76ee\u7684\u662f\u4e3a\u4e86\u53d1\u73b0\u539f\u59cb\u6570\u636e\u662f\u5426\u88ab\u4eba\u7be1\u6539\u8fc7\u3002\r\n ```\r\n\r\n- \u8f93\u51fa\u5230\u6307\u5b9a\u6587\u4ef6\r\n ```shell\r\n $ # -o \u6307\u5b9a\u8f93\u51fa\u6587\u4ef6\u8def\u5f84\r\n $ python -m prettymd -f .\\tests\\testfile.md -o testfile.md\r\n\r\n $ cat testfile.md\r\n \u6458\u8981\u7b97\u6cd5\u5c31\u662f\u901a\u8fc7\u6458\u8981\u51fd\u6570 f() \u5bf9\u4efb\u610f\u957f\u5ea6\u7684\u6570\u636e data \u8ba1\u7b97\u51fa\u56fa\u5b9a\u957f\u5ea6\u7684\u6458\u8981 digest\uff0c\u76ee\u7684\u662f\u4e3a\u4e86\u53d1\u73b0\u539f\u59cb\u6570\u636e\u662f\u5426\u88ab\u4eba\u7be1\u6539\u8fc7\u3002\r\n ```\r\n\r\n- \u4ee3\u7801\u8c03\u7528\r\n ```python\r\n >>> from prettymd import format\r\n >>> format('\u8fd9\u662f\u4e00\u4e2a\u793a\u4f8brst\u6587\u6863')\r\n '\u8fd9\u662f\u4e00\u4e2a\u5b9e\u4f8b rst \u6587\u6863'\r\n\r\n >>> from prettymd import format\r\n >>> format('\u8fd9\u662f\u4e00\u4e2a\u793a\u4f8brst\u6587\u6863', style='code')\r\n '\u8fd9\u662f\u4e00\u4e2a\u5b9e\u4f8b `rst` \u6587\u6863'\r\n\r\n >>> # \u4e3a\u6807\u9898\u6dfb\u52a0\u7d22\u5f15\r\n >>> from prettymd import format\r\n >>> print(format(\"\"\"\r\n ## h2\r\n ### h3\r\n ## h22\r\n #### h4\r\n \"\"\"))\r\n\r\n ## 1. h2\r\n ### 1.1. h3\r\n ## 2. h22\r\n #### 2.0.1. h4\r\n ```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool that formats markdown text in Chinese.",
"version": "0.1.111",
"project_urls": {
"Homepage": "https://github.com/kingronjan/prettymd"
},
"split_keywords": [
"prettymd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81cd07563727ff5e45445fdc03893a43771cef5b00341a4a7758058da84b2997",
"md5": "e6a6994d45a628b9cbd9b1d726ffbcfb",
"sha256": "01afa0cc8c53f9649f30b15a8967f72255953444de0bd5cdde1d2095498de57e"
},
"downloads": -1,
"filename": "prettymd-0.1.111.tar.gz",
"has_sig": false,
"md5_digest": "e6a6994d45a628b9cbd9b1d726ffbcfb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 14557,
"upload_time": "2024-08-13T09:11:28",
"upload_time_iso_8601": "2024-08-13T09:11:28.956210Z",
"url": "https://files.pythonhosted.org/packages/81/cd/07563727ff5e45445fdc03893a43771cef5b00341a4a7758058da84b2997/prettymd-0.1.111.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 09:11:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kingronjan",
"github_project": "prettymd",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "prettymd"
}
JSON
