zerica
/
hugo
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix up the gemtext README

This commit is contained in:
Erica Z 2021-10-18 19:28:26 +02:00
parent c50f2481b6
commit 4d028fd20e
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
markup/gemtext/README.md
View File

@ -6,11 +6,11 @@ an (opinionated) converter to HTML.
## HTML conversion
The HTML converter (implemented [here](./convert.go)) generates the following elements:
* `p` for any sequence of non-empty text lines, where `br` is used to separate them
* `figure` for preformatted blocks, where the actual preformatted contents are inside a `pre` tag, and the alt text is inside a `figcaption`, if present
* `blockquote for any sequence of quote lines
* `h1`, `h2` and `h3` for header lines
* `ul` for both links and list lines:
* `figure` for preformatted lines, where the actual preformatted contents are inside a `pre` tag, and the alt text, if present, is inside a `figcaption`
* `blockquote` for any sequence of quote lines
* `h1`, `h2` and `h3` for heading lines
* `ul` for both link lines and unordered list items:
* Any sequence of non-empty link lines is output as a `ul` element with the `links` class, where each item is an `a` element prepended by a `li` tag
* Any sequence of non-empty list lines is output as a `ul` element with the `items` class, where each item is text prepended by a `li` tag
* Any sequence of non-empty unordered list items is output as a `ul` element with the `items` class, where each item is text prepended by a `li` tag
For convenience in testing, a standalone version of the converter is provided [here](./standalone/).