inscription 0.0.1

Parse machine-readable rules embedded in Markdown documents

inscription

Parse out machine-readable rules embedded in Markdown documents. The rules are still valid Markdown, so they can be easily read, edited, and understood by humans.

import inscription

markdown, rules = inscription.separate(text)

Rules are formatted as unordered lists, and must be the first things that appears in the section.

Normal Markdown appears alongside encoded rules.

# Valid rules

- Inventory _add_ Handaxe

Anything between the start of the section (or very start of file if it doesn't
begin with a header) are rules for computers.

# Invalid rules

- bananas
- raspberries

The rules must parse successfully, or they are treated as Markdown for humans.