Moire (pronounced as /mwɑː/) is a simple extendable multipurpose markup language.
There are 6 possible header levels: \1
, \2
, ..., \6
with syntax \<header level> {<header name>} {<header label>}
. E.g.: \2 {Section 3} {section-3}
.
Italic (\i
), bold (\b
), underlined (\u
), monospaced (\m
), strikethrough (\strike
), subscript (\sub
), superscript (\super
).
Example Moire code | Rendering |
---|---|
\i {text} |
text |
\b {text} |
text |
\m {text} |
text |
\strike {text} |
|
\sub {text} |
text |
\super {text} |
text |
Example Moire code | Rendering |
---|---|
\ref {http://example.com} {external link} |
external link |
\ref {#example-section} {internal link} |
internal link |
Example Moire code:
\list
{Item 1,}
{item 2.}
Rendering:
- Item 1,
- item 2.
Example Moire code:
\table
{{Header 1} {Header 2}}
{{Cell 1, 1} {Cell 1, 2}}
{{Cell 2, 1} {Cell 2, 2}}
Rendering:
Header 1 | Header 2 |
---|---|
Cell 1, 1 | Cell 1, 2 |
Cell 2, 1 | Cell 2, 2 |
Requirements: Python 3.8.
pip install .
Convert Moire file to other formats:
moire -i <Moire input file> -f <format> -o <output file> <other options>
E.g., this file is generated from Moire code using this command:
moire -i doc/readme.moi -o README.md -f DefaultMarkdown