自述.md生成器
readme-md的Python项目详细描述
安装
$ [sudo] pip install readme-md
功能
<section-name>.md节- attrs/properties/methods节-子类
readme_md.Readme - auto headers-如果第1节行不为空且不为
#header - 截面顺序-
Readme.order或order.txt - python项目（^{
} 必需）节-install，classes，functions，cli
类
<section-name>.md节readme_md.Readme#headerReadme.order或order.txtinstall，classes，functions，clireadme_md.Readme-readme.md生成器
| ^{ | ^{ |
|---|---|
| ^{ | header default lvl (4) |
| ^{ | dict with sections headers (optional) |
| ^{ | list of sections order |
| ^{ | dict with sections (loaded from .md files) |
| ^{ | ^{ |
|---|---|
| ^{ | return a string with section header |
| ^{ | return a string with README section |
| ^{ | return all sections in a list of (name, string) pairs sorted by ^{ |
| ^{ | load sections and order |
| ^{ | render to a string |
| ^{ | save to file |
函数
| function | ^{ |
|---|---|
| ^{ | return a list with broken markdown links |
| ^{ | return a list with markdown links |
| ^{ | return a string with class attributes table |
| ^{ | return a string with class name, description and attrs+methods+properties tables |
| ^{ | return a string with class methods table |
| ^{ | return a string with class properties table |
| ^{ | return a string with cli modules usage table. ^{ |
cli
| usage | ^{ |
|---|---|
| ^{ | print README.md broken links |
| ^{ | generate README.md |
| ^{ | print README.md links |
示例
# .README/examples.md, .README/features.md, .README/order.txt $ python -m readme_md.create .README > README.md $ python -m readme_md.broken_links README.md # find broken links
classReadme_npm(readme_md.Readme):order=["description","features","install",...]disabled=["generator"]@propertydefinstall(self):return"`$ [sudo] npm i -g %s`"%json.loads(path)["name"]
Readme(".README").save("README.md")# load sections and create README.md
readme-md-readme.md生成器
欢迎加入QQ群-->： 979659372
