MarkShup development

Development and release commands

Run the development version from the repository root:

./markshup --help

Run the test suite:

./run test

Create a standalone executable at .deploy/markshup:

./run deploy [VERSION]

Deployment also creates the compressed archive .deploy/markshup_VERSION.zip.

Remove deployment artifacts:

./run clean

Generate the self-contained documentation website in site/:

./util/update-site.sh

Deployment runs the complete test suite first and stops if any test fails. The release executable embeds the parser and has no dependency on the source checkout.

Development documentation

• Architecture describes the source layout and parser design.
• Still missing records missing features and known parser limitations.
• Showcase is a visual Markdown regression fixture.
• Tests describes the test stages and test helpers.