mortoray / mdl

My markdown language for documents: blogs, ebooks, and print

MDL - Mortoray's Document Language

My multi-purpose markdown language. MDL combines a document language, similar to markdown, with a structured header language, similar to YAML.

I use this tool on a day-to-day basis for my own work. It is fairly stable, though I can't guarantee I won't add anything that changes the formatting, or accepts a new syntax. As I use it on more sites, it becomes ever more stable.

Follow the development at mortoray.com or follow me on Mastadon

I actively use this generator/parser for:

• Edaqa's Kitchen: Healthy modern recipes. I use it for the text part of recipes.
• Edaqa's Room: Online escape rooms. I use MCL for the primary game script as well as the document language for the grimoire.
• Musing Mortoray: Technical Blog. I'm using the document language to write articles and publish in multiple formats.

Running

There is an entry point defined on the module that that reads MDL files and emits either HTML or Markdown.

python -m mdl --help

Example:

python -m mdl README.mdl --write markdown README.md

Be aware that not all emitters will support all of the doc-tree at any given time. It's all in flux now.

Python 3.10

NOTE: Uncertain if this is still needed/up-to-date

sudo apt install python3.10-distutils python3.10-dev

mdl's Issues

Idea

if perhaps:

e=self.output.write

then perhaps code could fit 80 lines.
By enabling the linter, one would get nice linting, which might be a thing someone might one.

mdl/mdl/format_html.py

Line 190 in b7fbf23

def _write_list( self, node ):

Italics don't work with spaces

The log/3 didn't format correctly on dev.to due to trailing spaces on the user portrait paragraph. Markdown italics endings must come immediately after the text to be recognized.

This is related to stripping and normalizing spaces.