Table of Contents
=================
* `renderme <#renderme>`_
* `Installation <#installation>`_
* `Usage <#usage>`_
* `Examples: <#examples>`_
renderme
========
Render markdown templates by injecting table of contents and shell command output.
Installation
============
``pip install renderme``
Usage
=====
.. code-block::
usage: rendermd [-h] [-p PATTERNS] [--no-recursive]
Render markdown templates. This command recursively search the current
directly and find all markdown files by matching given patterns (default to
"**/README.md").
optional arguments:
-h, --help show this help message and exit
-p PATTERNS, --pattern PATTERNS
Comma separated list of markdown files to populate
--no-recursive Do not search for files recursively
Examples:
---------
* ``[//]: # (start:toc)`` and ``[//]: # (end)`` will produce table of contents.
* ``[//]: # (start:shell``\ echo abc\ ``)`` and ``[//] # (end)`` will produce ``abc`` (the output of the shell command ``echo abc``.
* More examples can be found in `test_toc_generator.py <./tests/test_toc_generator.py>`_ and `test_shell_generator.py <./tests/test_shell_generator.py>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/conanfanli/rendermd",
"name": "rendermd",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.11",
"maintainer_email": null,
"keywords": "Python, TypeScript, Dataclass, Code Generation",
"author": "Conan Li",
"author_email": "conanlics@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/08/2e/a1a13508ff56fb514a3398aa5561f61aba96a788e31aa6fb37607c1c2cf0/rendermd-0.5.0.tar.gz",
"platform": null,
"description": "\nTable of Contents\n=================\n\n\n* `renderme <#renderme>`_\n* `Installation <#installation>`_\n* `Usage <#usage>`_\n\n * `Examples: <#examples>`_\n\nrenderme\n========\n\nRender markdown templates by injecting table of contents and shell command output.\n\nInstallation\n============\n\n``pip install renderme``\n\nUsage\n=====\n\n.. code-block::\n\n usage: rendermd [-h] [-p PATTERNS] [--no-recursive]\n\n Render markdown templates. This command recursively search the current\n directly and find all markdown files by matching given patterns (default to\n \"**/README.md\").\n\n optional arguments:\n -h, --help show this help message and exit\n -p PATTERNS, --pattern PATTERNS\n Comma separated list of markdown files to populate\n --no-recursive Do not search for files recursively\n\nExamples:\n---------\n\n\n* ``[//]: # (start:toc)`` and ``[//]: # (end)`` will produce table of contents.\n* ``[//]: # (start:shell``\\ echo abc\\ ``)`` and ``[//] # (end)`` will produce ``abc`` (the output of the shell command ``echo abc``.\n* More examples can be found in `test_toc_generator.py <./tests/test_toc_generator.py>`_ and `test_shell_generator.py <./tests/test_shell_generator.py>`_\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python type code generator",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/conanfanli/rendermd"
},
"split_keywords": [
"python",
" typescript",
" dataclass",
" code generation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f1a56e5d00f4779683da384b6396f8fb00a9a39d34f8a79b1ccf9118e34fb80",
"md5": "5b1623602fcfd427cdf8432b44f1badf",
"sha256": "e90703c20945cd73cd54c0b0c0569bc57dca4666485b009fc399488146c52b81"
},
"downloads": -1,
"filename": "rendermd-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b1623602fcfd427cdf8432b44f1badf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.11",
"size": 9097,
"upload_time": "2024-05-21T18:13:39",
"upload_time_iso_8601": "2024-05-21T18:13:39.023222Z",
"url": "https://files.pythonhosted.org/packages/7f/1a/56e5d00f4779683da384b6396f8fb00a9a39d34f8a79b1ccf9118e34fb80/rendermd-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "082ea1a13508ff56fb514a3398aa5561f61aba96a788e31aa6fb37607c1c2cf0",
"md5": "1d884eec0515e585dae2b93553490cbc",
"sha256": "d1000a21b14fd443be00ae103a908b465f1f833ffcff09c98400b74248dbd4c8"
},
"downloads": -1,
"filename": "rendermd-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "1d884eec0515e585dae2b93553490cbc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.11",
"size": 7384,
"upload_time": "2024-05-21T18:13:40",
"upload_time_iso_8601": "2024-05-21T18:13:40.014448Z",
"url": "https://files.pythonhosted.org/packages/08/2e/a1a13508ff56fb514a3398aa5561f61aba96a788e31aa6fb37607c1c2cf0/rendermd-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 18:13:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "conanfanli",
"github_project": "rendermd",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "rendermd"
}
JSON
