Add support for blockquotes, paragraphs and deleted text, update README and example
This commit is contained in:
parent
78dd3bfda9
commit
fc5cfda87d
SSH key fingerprint:
SHA256:6v88GlRHW+S4NVmM00ZxofEJlnDdK8LI1EcfR8jrgDs
3 changed files with 80 additions and 94 deletions
105
README.md
105
README.md
|
|
@ -2,19 +2,12 @@
|
|||
|
||||
Mint is a minimal text markup language that can be compiled to html.
|
||||
|
||||
As of version 0.1, mint supports
|
||||
|
||||
- comments
|
||||
- headings
|
||||
- subheadings
|
||||
- italic text
|
||||
- bold text
|
||||
- underline text
|
||||
- keep whitespaces (html `<pre>`)
|
||||
- manual line breaks (html `br`)
|
||||
For a syntax- and feature-overview, have a look at [Quick Reference](#quick-reference).
|
||||
|
||||
|
||||
# Syntax
|
||||
# Markup
|
||||
|
||||
Version 1.x
|
||||
|
||||
> [!NOTE]
|
||||
> See `example.mint` for a working usage example.
|
||||
|
|
@ -23,75 +16,49 @@ Like HTML, Mint uses tags to style documents.
|
|||
A tag consists of a forward slash `/`, one letter (e.g. `b`) and another forward slash.
|
||||
Tags toggle a style, so you can start bold text with `/b/` and end it with `/b/`.
|
||||
|
||||
## Comments
|
||||
|
||||
```
|
||||
/#/This is a comment/#/
|
||||
```
|
||||
> [!WARNING]
|
||||
> Comments aren't compiled into html comments, but skipped!
|
||||
## Quick Reference
|
||||
|
||||
|
||||
## Headings and Sub-headings
|
||||
|
||||
```
|
||||
/h/Heading/h/
|
||||
|
||||
/s/Subheading/s/
|
||||
```
|
||||
|
||||
Headings are compiled into `<h1>`, subheadings into `<h2>`.
|
||||
|
||||
|
||||
## Bold, italic and underlined text
|
||||
|
||||
```
|
||||
Text can be /b/bold/b/, /i/italic/i/ and /u/underlined/u/, or /b//i//u/everything at once/b//i//u/.
|
||||
```
|
||||
|
||||
## Keep whitespaces
|
||||
|
||||
Whitespaces (spaces, newlines, etc.) won't get rendered in HTML.
|
||||
To preserve whitespaces, use
|
||||
|
||||
```
|
||||
/e/
|
||||
This text
|
||||
will be indented.
|
||||
/e/
|
||||
```
|
||||
|
||||
## Newlines
|
||||
|
||||
You can insert newlines with
|
||||
|
||||
```
|
||||
/l/
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> This tag cannot be closed.
|
||||
|
||||
|
||||
## Escape slashes
|
||||
|
||||
If you want to write a `/`, use a
|
||||
|
||||
```
|
||||
//
|
||||
```
|
||||
| Markup | HTML | Meaning |
|
||||
| :---------: | :--------------: | ---------------------- |
|
||||
| `/#/.../#/` | | Comment (**not compiled into HTML!**) |
|
||||
| `/p/.../p/` | `<p>...</p>` | Paragraph |
|
||||
| `/q/.../q/` | `<blockquote>...</blockquote>` | Blockquote |
|
||||
| `/h/.../h/` | `<h1>...</h1>` | Heading |
|
||||
| `/s/.../s/` | `<h2>...</h2>` | Subheading |
|
||||
| `/i/.../i/` | `<i>...</i>` | _Italic text_ |
|
||||
| `/b/.../b/` | `<b>...</b>` | **Bold text** |
|
||||
| `/u/.../u/` | `<u>...</u>` | <u>Underlined text</u> |
|
||||
| `/d/.../d/` | `<s>...</s>` | ~~Deleted text~~ |
|
||||
| `/e/.../e/` | `<pre>...</pre>` | Keep whitespaces (spaces, new lines, ...) |
|
||||
| `/l/` | `<br>` | Line-break (new line) |
|
||||
| `//` | `/` | Escape a forward slash |
|
||||
|
||||
|
||||
# Converter
|
||||
|
||||
To convert mint to html, use `mint2html.py`.
|
||||
To convert mint to html, use the `mint2html.py` commandline tool.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
## Supported platforms
|
||||
|
||||
I develop and test on **Linux** with **Python 3.13**, so the code should generally run on Unix-based systems.
|
||||
|
||||
There is no code implemented that only works on Unix systems, so it _should_ work on Microslop Windows, although I'm too lazy to test this.
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
./mint2html.py -i input_file.mint -o output_file.html
|
||||
```
|
||||
|
||||
You can also omit the input/output files to read from stdin/output to stdout.
|
||||
|
||||
Use `mint2html.py --help` to view the full help text.
|
||||
|
||||
Tip: If you are in a bash shell, and have pandoc installed, you can pipe the output of mint2html.py directly into pandoc, e.g.:
|
||||
|
||||
```bash
|
||||
/mint2html.py --input-file example.mint --minify | pandoc --from html -o example.epub
|
||||
```
|
||||
|
|
|
|||
38
example.mint
38
example.mint
|
|
@ -3,34 +3,40 @@
|
|||
|
||||
/#/ Example comment /#/
|
||||
|
||||
/l/
|
||||
|
||||
/p/
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
/p/
|
||||
|
||||
/s/A Subheading/s/
|
||||
|
||||
Here you can see /#/ an inline comment and/#/ /b/bold/b/, /i/italic/i/ and /u/underlined/u/ text.
|
||||
Mint supports /#/ inline comments and/#/ /b/bold/b/, /i/italic/i/ and /u/underlined/u/ text.
|
||||
|
||||
/#/ put a newline: /#/
|
||||
/l/
|
||||
/#/ put a newline: /#/ /l/
|
||||
|
||||
You can also /d/strike-through/d/ text to indicate that it has been deleted.
|
||||
|
||||
/u//i/Obviously/i/, you can /b/mix/b//u/ styles.
|
||||
|
||||
/l//l/
|
||||
/p/
|
||||
Show off a quote:
|
||||
|
||||
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
|
||||
/q/
|
||||
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.
|
||||
/l//l/
|
||||
/i/- "de Finibus Bonorum et Malorum", Cicero/i/
|
||||
/q/
|
||||
/p/
|
||||
|
||||
/s/Another Subheading/s/
|
||||
|
||||
Enforce a // with "////" to get //u//, //i//, etc..
|
||||
Enforce a // with "////" to get //u//, //i//, etc.
|
||||
or an url like https:////example.org
|
||||
|
||||
/e/Can also have blocks where whitespaces are kept as-is.
|
||||
which means you can do stuff like
|
||||
/u/this/u/.
|
||||
/e/You can also have sections where whitespaces are kept as-is.
|
||||
... which means you can do stuff like
|
||||
/u/this/u/.
|
||||
/e/
|
||||
|
||||
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.
|
||||
|
||||
/l//l/
|
||||
|
||||
https:////example.org
|
||||
/p/
|
||||
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
|
||||
/p/
|
||||
|
|
|
|||
31
mint2html.py
31
mint2html.py
|
|
@ -40,13 +40,16 @@ class ConverterState:
|
|||
# wether this cycle actually converted something:
|
||||
cycle_had_op = False
|
||||
|
||||
# (in)active styles/formats
|
||||
# (in)active styles/formats/blocks
|
||||
comment = False
|
||||
paragraph = False
|
||||
blockquote = False
|
||||
heading = False
|
||||
subheading = False
|
||||
italic = False
|
||||
bold = False
|
||||
underline = False
|
||||
strike_through = False
|
||||
whitespace_pre = False
|
||||
|
||||
def complete_cycle(self):
|
||||
|
|
@ -64,14 +67,21 @@ class MintToHtmlConverter:
|
|||
'''A simple converter from Mint to HTML
|
||||
Currently supports:
|
||||
|
||||
- comments /#/
|
||||
- heading /h/
|
||||
- subheading /s/
|
||||
- italic /i/
|
||||
- bold /b/
|
||||
- underline /u/
|
||||
- keep whitespaces /e/
|
||||
- line breaks /l/
|
||||
- comments /#/
|
||||
|
||||
- paragraphs /p/
|
||||
- block quotes /q/
|
||||
|
||||
- headings /h/
|
||||
- subheadings /s/
|
||||
|
||||
- italic /i/
|
||||
- bold /b/
|
||||
- underline /u/
|
||||
- deleted (strike-through) /d/
|
||||
|
||||
- keep whitespaces /e/
|
||||
- line breaks /l/
|
||||
'''
|
||||
|
||||
def __init__(
|
||||
|
|
@ -83,11 +93,14 @@ class MintToHtmlConverter:
|
|||
self.css = css
|
||||
self.tags = [
|
||||
MintTagToHtml("#", None, "comment"),
|
||||
MintTagToHtml("p", "p", "paragraph"),
|
||||
MintTagToHtml("q", "blockquote", "blockquote"),
|
||||
MintTagToHtml("h", "h1", "heading"),
|
||||
MintTagToHtml("s", "h2", "subheading"),
|
||||
MintTagToHtml("i", "i", "italic"),
|
||||
MintTagToHtml("b", "b", "bold"),
|
||||
MintTagToHtml("u", "u", "underline"),
|
||||
MintTagToHtml("d", "s", "strike_through"),
|
||||
MintTagToHtml("e", "pre", "whitespace_pre"),
|
||||
MintTagToHtml("l", "br", None)
|
||||
]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue