2
0 Comments

Configurable Markdown-like language

Hi, Touch is a Markdown-like language that is configurable, comes with attributes and comments, and has auto-formatting (like gofmt or prettify).

I am a developer and write documentation all the time. I used to write docs in Markdown (CommonMark) and later pandoc , but the more I used it the more dissatisfied I was.

pandoc (variant of Markdown) offers a lot of extra features but its syntax sticks out and is quite distracting; also by using these features my source was incompatible with other markdown variants. Touch tries to solve this by having a set of common elements (like normal markdown) but allows for extra elements to be added via JSON config.

Additionally, I primarily work with Golang and I love gofmt (auto-formatting). And that's what I also wanted for my docs and that's what I did. Auto-formatting eases mental strain required for writing and makes collaboration easier.

I envison a writing process like this:

  1. write in plain text without interruptions (I like to write each sentence on its own line)
  2. add markup - add empahses, blockquotes, etc.
  3. add style using attributes (which are like HTML-attributes)
  4. auto-format - formats the document into standard form which means no matter who in your team reads/writes the document, it will be in the same format which makes it easier to read and comprehend
  5. export/convert to any format

The current Github README is developer-oriented but I am looking to release an online playground in a couple of days for everyone to try. If you need any help, don't hesitate to ask me (I look forward to it).

The project is MIT licensed:
https://github.com/touchmarine/to

on November 30, 2021