render-engine / render-engine-markdown

Parser for markdown used in Render Engine

Markdown Parser

This is a parser for the Markdown markup language. This is the default parser for render_engine pages.

Markdown is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name.

The underlying parser is python-markdown2.

Parser Options

These are the options that can be pulled from the page:

Option	Description
markdown_extras	A list of extensions to use. See python-markdown2 for a list of extensions.

Quickstart

import the MarkdownPageParser

Render Engine includes the parser in render_engine.parsers.markdown Alternatively, you can import directly from this path

from render_engine.parsers.markdown import MarkdownPageParser
# of from render_engine_markdown import MarkdownPageParser

class MyMarkdownPage(Page):
    Parser = MarkdownPageParser
    content_path = "path_to_your_markdown_file.md"

render-engine-markdown's Issues

Add docs and GitHub pages

create docs from the markdown and the pico template

Create a PR Template and an Issue Template to make contributing easier

We need to create a pull request template and issue templates for this repo to make contributing to it easier.

You may reference the templates at the main render engine repo to help you.

We only need to create templates here just like the ones on the main repo.

Create H1 title parser extra? (Potential new parser)

A common paradigm is to have the first line be an H1 and use the title of the page to be first h1 from the site.

Pros:
You'd need to check the first H1 in the content. This would likely need to have some scraping tool be a dependency which seems like a lot for get the first H1

You could do a regular expression to search for "^ *#[^#].*$" but you may also want to do things like Titlecase your title and other options. I think if all were adding is titlecase then I would be okay with two parser extras like "titlecase" and "title_from_h1"