interactive terminal markdown-documentation viewer with support for images and with code-highlighting.
Note: currently TermDocs was developed to run on linux based machines, but should also work on Windows or Mac. (But the installation process might be slightly different and is currently not documented)
go to the online documentation and follow the steps in the getting-started section.
Afterward you can start TermDocs with termdocs [docs-folder] and optionally press F1 for a preview of what TermDocs can do.
Full support for (basically) all markdown features with some additional:
- headers
- paragraphs
- styling (bold, italic,
strikethrough,inline code) -
+ code blocks (with syntax-highlighting) -
cites
- lists
- with sublists
- tables
- images (also animated and vector graphics (svg))
- html-blocks (if rendered in markdown style)
(Even if it doesn't look like a terminal. It is. Don't believe me? Try it!)
