Skip to main content

Table of Contents

renderme

Render markdown templates by injecting table of contents and shell command output.

Installation

pip install renderme

Usage

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:shellecho abc) and [//] # (end) will produce abc (the output of the shell command echo abc.

  • More examples can be found in test_toc_generator.py and test_shell_generator.py

Metadata

Release files for rendermd 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rendermd 0.6.1
File Size Uploaded Provenance
rendermd-0.6.1.tar.gz 7.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for rendermd 0.6.1
File Interpreter ABI Platform
rendermd-0.6.1-py3-none-any.whl Python 3 none any Details

Total release size: 16.8 kB

Release files / rendermd-0.6.1.tar.gz

Download URL rendermd-0.6.1.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
7e2bae42b5800a0ff236e6c0eafce9109c5b25fd31d6e8aec2cc7aec9b2e3be7
BLAKE2b-256 checksum
How to use checksums
afe2245397cc064a6b96b88e33067c85db33d33cef32f54761e02db98f1a8920
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.18

Release files / rendermd-0.6.1-py3-none-any.whl

Download URL rendermd-0.6.1-py3-none-any.whl
Size 9.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4fa78fb1a6a4a01997d12095b0f8ebb97648613e4049f1a13024422b64a55b63
BLAKE2b-256 checksum
How to use checksums
1b974fe1060f9fe2a65b7ef300ad78628006c23e8cac9c2059d778dc9b782d2e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.18

Security for rendermd 0.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page