This formal specification of Markua was developed at Leanpub, is written by Peter Armstrong, is based on the CommonMark Spec by John MacFarlane, and is licensed under the Creative Commons license CC-BY-SA 4.0.
This spec is currently UNIMPLEMENTED, and is subject to change!
If you are a Leanpub author, DO NOT READ THIS.
Instead, you should be reading the Markua Manual, not this document!
The Markua Manual documents the version of Markua 0.1 which is used on Leanpub.
This document is a bunch of forward-looking statements which guide the ongoing development of Markua 0.29 on Leanpub. We have not yet shipped the beta of Markua 0.29, so at the moment, this document is just for interest and feedback, not actual use by authors.
This document is also subject to change: I make mistakes, and as we implement this specification on Leanpub, I'm realizing just how many!
This is the Markua Spec, written by Peter Armstrong.
The Markua Spec is based on the CommonMark Spec, whose author is John MacFarlane.
This document also incorporates the specification of three of the five GitHub Flavored Markdown (GFM) extensions from the GFM Spec.
Like the CommonMark Spec and the GFM Spec, the Markua Spec is licensed under the Creative Commons license CC-BY-SA 4.0.
This document has two types of intended readers:
- authors with advanced questions about Markua syntax
- developers implementing Markua Processors
The Introduction contains a number of introductory sections about Markua and its relationship to Markdown, CommonMark and GFM. It also contains sections which discuss Leanpub, to minimize confusion for Leanpub authors who encounter this document.
If you're going to read this document, you really should read the Introduction, even if you normally skip them.
Markua is being specified on the master branch.
Leanpub Flavoured Markdown (LFM) is being specified on the lfm branch.
To build the spec you will need docker installed. You can check with
docker -v
if you dont have docker you can download it from https://www.docker.com/products/docker-desktop
You will need the repository cloned, and then using the terminal navigate into the root of the repository on the master branch.
Once there you can run ./spec.sh, this will create a docker container, generate the spec.html file in $HOME/Desktop by default, and then stop and remove the docker container. You can add a -o [filepath] flag to specify an output file path. The script will expect that spec.txt which it uses to build spec.html will be in the root, where it is by default.