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/af/e2/245397cc064a6b96b88e33067c85db33d33cef32f54761e02db98f1a8920/rendermd-0.6.1.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.6.1",
"project_urls": {
"Homepage": "https://github.com/conanfanli/rendermd"
},
"split_keywords": [
"python",
" typescript",
" dataclass",
" code generation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b974fe1060f9fe2a65b7ef300ad78628006c23e8cac9c2059d778dc9b782d2e",
"md5": "2ec54550e337bc3981f3a1eeae511aa6",
"sha256": "4fa78fb1a6a4a01997d12095b0f8ebb97648613e4049f1a13024422b64a55b63"
},
"downloads": -1,
"filename": "rendermd-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ec54550e337bc3981f3a1eeae511aa6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.11",
"size": 9314,
"upload_time": "2024-08-09T13:12:15",
"upload_time_iso_8601": "2024-08-09T13:12:15.543625Z",
"url": "https://files.pythonhosted.org/packages/1b/97/4fe1060f9fe2a65b7ef300ad78628006c23e8cac9c2059d778dc9b782d2e/rendermd-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "afe2245397cc064a6b96b88e33067c85db33d33cef32f54761e02db98f1a8920",
"md5": "ad545017df5607e9daed847ee770fa20",
"sha256": "7e2bae42b5800a0ff236e6c0eafce9109c5b25fd31d6e8aec2cc7aec9b2e3be7"
},
"downloads": -1,
"filename": "rendermd-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "ad545017df5607e9daed847ee770fa20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.11",
"size": 7529,
"upload_time": "2024-08-09T13:12:16",
"upload_time_iso_8601": "2024-08-09T13:12:16.891789Z",
"url": "https://files.pythonhosted.org/packages/af/e2/245397cc064a6b96b88e33067c85db33d33cef32f54761e02db98f1a8920/rendermd-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 13:12:16",
"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
