Metadata-Version: 2.1
Name: rendermd
Version: 0.6.1
Summary: Python type code generator
Home-page: https://github.com/conanfanli/rendermd
Author: Conan Li
Author-email: conanlics@gmail.com
License: MIT
Description: 
        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>`_
        
Keywords: Python,TypeScript,Dataclass,Code Generation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Requires-Python: ~=3.11
Provides-Extra: dev
