Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikeckennedy/markdown-subtemplate

A template engine to render Markdown with external template imports and basic variable replacements. #pypackage
https://github.com/mikeckennedy/markdown-subtemplate

django flask jinja2 markdown pyramid python web

Last synced: 10 days ago
JSON representation

A template engine to render Markdown with external template imports and basic variable replacements. #pypackage

Awesome Lists containing this project

README 

        
# markdown-subtemplate 

[![](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/) 

[![](https://img.shields.io/pypi/l/markdown-subtemplate.svg)](https://github.com/mikeckennedy/markdown-subtemplate/blob/master/LICENSE)

[![](https://img.shields.io/pypi/dm/markdown-subtemplate.svg)](https://pypi.org/project/markdown-subtemplate/)



A template engine to render Markdown with external template imports and basic variable replacements.



## Motivation



We often make a choice between data-driven server apps (typical Flask app), CMSes that let us edit content on the web such as WordPress, and even flat file systems like Pelican.



These are presented as an either-or. You either get a full database driven app or you get a CMS, but not both. This project is meant to help add CMS like features to your data-driven web apps and even author them as static markdown files.



Here's how it works:



1. You write standard markdown content.

2. Markdown content can be shared and imported into your top-level markdown.

3. Fragments of HTML can be used when css classes and other specializations are needed, but generally HTML is avoided.

4. A dictionary of variables and their values to replace in the merged markdown is processed.

5. Markdown content is converted to HTML and embedded in your larger site layout (e.g. within a Jinja2 template).

6. Markdown transforms are cached to achieve very high performance regardless of the complexity of the content.



## Standard workflow



Write markdown content, merge it with other markdown files, deliver it as HTML as part of your larger site.



![](https://raw.githubusercontent.com/mikeckennedy/markdown-subtemplate/master/readme_resources/workflow_image_layout.png)



## Usage



To use the library, simply install it.



```bash

pip3 install markdown-subtemplate

``` 



Next, write a markdown template, `page.md`:



```markdown

## This is a sub-title



* Here's an entry

* And another

```



Register the template engine in your web app startup:



```python

from markdown_subtemplate import engine

# Set the template folder so that when you ask for page.md 

# the system knows where to look.



engine.set_template_folder(full_path_to_template_folder)

```



Then generate the HTML content via:



```python

data = {'variable1': 'Value 1', 'variable2': 'Value 2'}

contents = engine.get_page('page.md', data)

```



Finally, pass the HTML fragment to be rendered in the larger page context:



```python

# A Pyramid view method:



@view_config(route_name='landing', renderer='landing.pt')

def landing(request):

    data = {'variable1': 'Value 1', 'variable2': 'Value 2'}

    contents = engine.get_page('page.md', data)



    return {

        'name': 'Project name',

        'contents': contents

    }

```



And the larger website template grabs the content and renders it, `landing.pt`:



```html

...



    ${structure:contents}



...

```



## Beware the danger!



This library is meant for INTERNAL usage only. It's to help you add CMS features to your app. It is **not** for taking user input and making a forum or something like that.



To allow for the greatest control, you can embed small fragments of HTML in the markdown (e.g. to add a CSS class or other actions). This means the markdown is processed in **UNSAFE** mode. It would allow for script injection attacks if opened to the public.



## Extensibility



`markdown-subtemplate` has three axis of extensibility:



* **Storage** - Load markdown content from disk, db, or elsewhere.

* **Caching** - Cache generated markdown and HTML in memory, DB, or you pick!

* **Logging** - If you are using a logging framework, plug in logging messages from the library.



See the [extensibility doc](https://github.com/mikeckennedy/markdown-subtemplate/blob/master/extensibility.md) for details and examples.

 

 

## Nested markdown



One of the reason's this project exists, rather than just passing markdown text to a markdown library is allowing nesting / importing of markdown files.



If you have page fragments that need to appear more than once, create a dedicated markdown import file that can be managed and versioned in one place. Here's how:



### Created an imported file in TEMPLATES/_shared



All imported markdown files are located in subpaths of `TEMPLATES/_shared` where `TEMPLATES` is the path you set during startup.



```

TEMPLATES

    |- _shared

        |- contact.md

        |- footer.md

    |-pages

        | - page.md

        | - about.md

```



Write the imported / shared markdown, `contact.md`:



```markdown

Contact us via email [[email protected]](mailto:us.com) or on 

Twitter via [@us](https://twitter.com/us)

```



Then in your page, e.g. `page.md` you can add an import statement:



```markdown

# Our amazing page



Here is some info **about the page**. It's standard markdown.



Want to contact us? Here are some options:

[IMPORT CONTACT]



And a footer:

[IMPORT FOOTER]

```



The resulting markdown is just replacing the `IMPORT` statements with the contents of those files, then passing the whole thing through a markdown to HTML processor.



## Variables



`markdown_subtemplate` has some limited support for variable replacements. Given this markdown page:



```markdown

# Example: $TITLE$



Welcome to the $PROJECT$ project. Here are some details 

...

```



You can populate the variable values with:



```python

data = {'title': 'Markdown Transformers', 'project': 'sub templates'}

contents = engine.get_page('page.md', data)

```



Note that the variable names must be all-caps in the template. Missing variable statements in markdown that appear in the data dictionary are ignored.



## Variables within nested templates



One problem you might run into is you have some reusable section, like this:



```

// shared_promo.md



We are running a special! Click here to see the featured item:



[Our latest project, 50% off](/markdown-editor?utm_source={SOMETHING_FROM_THE_PAGE})

```



It's generally reusable, but you want that `SOMETHING_FROM_THE_PAGE` to vary depending on which page they are on. 

You could do this in Python code but that would be out of band and actually a little hard to do. So you can

now define hierarchical variables in markdown. 



Define nested variables as follows with `name=VARNAME` and `value=var-value`:



```

[VARIABLE VARNAME="var-value"]

```



In the following page, we choose a `source` and reuse this shared template:



```

// top-level.md



# Welcome to the page



Page content here...



[VARIABLE SOMETHING_FROM_THE_PAGE="editor-youtube-landing-page"]

[IMPORT shared_promo]

```



The result would be effective this markdown, then turned into HTML:



```markdown

# Welcome to the page



Page content here...



We are running a special! Click here to see the featured item:



[Our latest project, 50% off](/markdown-editor?utm_source=editor-youtube-landing-page)

```



Just like regular variables, they are enclosed in `{` and `}` and are upper case where they are used.



## Requirements



This library requires **Python 3.6 or higher**. Because, *f-yes*! (f-strings).



## Licence



`markdown-subtemplate` is distributed under the MIT license.



## Authors



`markdown_subtemplate` was written by [Michael Kennedy](https://github.com/mikeckennedy).