KIST Markup Quick Reference
KIST Markup by Richard Rathe, v0.17, March 2024
KIST Combines the best elements of various plain text markup languages…
- File names should end in
.txt
or.text
. - Blank Lines separate elements from each other.
- Tab characters have special meaning:
- Leading tabs indicate list items.
- Embedded tabs indicate tabular data.
- Headings, lists, and tables must be well structured (hierarchal).
Line Level Elements
Adjoining lines of text will be become a single paragraph.
#
first on a line indicates a heading, ##
a subheading, etc.
=
first indicates pre-formatted text.
>
first indicates a block quotation.
---
first indicates a horizontal line.
^
first indicates an inline image.
Lists
<tab>
first indicates a list, <tab><tab>
a sublist, etc.
<tab>
first followed by #
indicates a numbered list.
- List
- Sublist
- Numbered List
- Second Item
- Sublist
- End of List
Tables
- Direct use of tab-delimited data (
.tab
or.tsv
files). - A leading '^' char on the first line indicates column headings.
| a | b | c |
|---|---|---|
| 1 | 2 | 3 |
| 4 | 5 | 6 |
Text Elements (Cannot Span Lines!)
Hypertext
^Text(Link) format
Link to ^Weather Report(https://forecast.weather.gov/).
Valid local file extensions are: html htm txt text pdf
Link to ^Local File(kist-quickref.txt) in the same directory.
Link to a Local File in the same directory.
Images
- Inline images take up the full width of the text.
- Floating images will appear smaller, embedded within a paragraph.
Alt Text
should be a short description of the image.
^Alt Text(Image) format
^Yellow Flower(kist_images/picture2.jpg)
Valid image file extensions are: jpg jpeg gif png
Miscellaneous
Star characters *add emphasis*.
Star characters add emphasis.
Double quotes indicate "quotation". (duh!)
Double quotes indicate quotation
. (duh!)
Curly Brackets will {highlight} a passage.
Curly Brackets will highlight a passage.
Hyphens will -strikethrough- a passage.
Hyphens will strikethrough a passage.
Consult the full documentation for additional features… mdpaths.com/kist/