~skuzzymiglet/typeup-doc

A markup language for typists (documents repo)
rename syntax-test to example-document
Update example document (slimming down)
readme - clarify this repo's purpose

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~skuzzymiglet/typeup-doc
read/write
git@git.sr.ht:~skuzzymiglet/typeup-doc

You can also use your local clone with git send-email.

#typeup - a markup language for typists

This repo holds an example document demonstrating every element of the typeup syntax and a cross-implementation README. In the future, it will hold the spec

Markdown is a pretty good format. It's omnipresent and has so many variants. However, over the course of writing notes in Markdown, I've sometimes found it somewhat bumpy to type. Typeup is my attempt at a more streamlined, ergonomic markdown.

#Status

#Tools

typeup is a work-in-progress project. There are 3 translators in development right now:

All are work in progress

#Spec

typeup doesn't yet have a spec, but an example of every element of the syntax is available

#Contribute!

If you want to join in, my contact details are at skuz.xyz

#Principles

  • Visual and typing overhead should be as low as possible - links are 2 more characters, half of Markdown's overhead
  • Prefer writeability over looks -
  • Humans shouldn't have to care about whitespace - there are no tabs in the typeup syntax
  • Different isn't necessarily better
  • A parser should be self-contained with no dependencies - which means no JSON front matter or URL validation in the spec
  • Extending the language should be done in a uniform and simple way - using custom blocks, just about anything can be done in a typeup document
  • Choice is valuable - there are 2 ways to do code, bold and italics - easy to type ways and lighter ways that require use of the shift key or moving one's hands around.

#Syntax

=# title: this becomes the page title in HTML, and document title in LaTeX and troff
# headings
## are
### h1
#### to
##### h6
###### as in markdown!
==bold text==: easy to type, emphatic
//italic text//: the slashes go rightwards, like the slant of italic text
*alternative bold form*, _alternative italic form_: these are similar to Markdown. They're shorter but a bit harder to type.
''code'', easy to type and `code`, compact
===
multiline code snippets are nicely fenced off
===
it's really easy to write [links https://skuz.xyz]
![this is a caption for an image https://thispersondoesnotexist.com/image]
[
this is an unordered list
lists are easy to type and nest in typeup, with low overhead
{
ordered list, nested inside an unordered list
}
]
pick your delimiter for tables!
#||{
X||Y||Z
A||B||C
}

#Undecided features

  • Metadata format: a lean format needs to be created for specifying metadata such as the author and date of a document, because we can't add a dependency on an existing parser (e.g. JSON, TOML or YAML)

#Potential features

  • Checklists
  • Table of contents: the current custom block architechture does not accommodate this.
  • Footnotes

#What typeup doesn't do

  • Syntax highlighting: building syntax highlighting into typeup would add a dependency. Also, there are many competing solutions and it should be up to the user which one they use. As with anything, syntax highlighting can be added with custom blocks
  • URL validation: this could add an extra dependency so it's not a requirement. Automatically turning URLs into links is also not a requiremenet