summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Wiesner <sebastian@swsnr.de>2019-02-06 14:44:36 +0100
committerGitHub <noreply@github.com>2019-02-06 14:44:36 +0100
commitbbaa23b241fa146c92f6e6f2ecfeb8c59e609f8b (patch)
treecf900af211d0d3e62052638de21dd8583f7b0e7f
parent12eb0b688426e31d00451e32327b3f1ee32a2683 (diff)
Rewrite features section in README
-rw-r--r--README.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/README.md b/README.md
index 4e42da5..be7a374 100644
--- a/README.md
+++ b/README.md
@@ -29,16 +29,13 @@ right), and [PragmataPro] as font.
## Features
`mdcat` works best with [iTerm2] or a compatible terminal emulator, and a good
-terminal font which includes italic characters. It supports
+terminal font with italic characters. Then it
-* All CommonMark syntax
-* Syntax highlighting for code blocks
-* Inline links (note the dashed underline like in the screenshot above, in some
- terminals)
-* Inline images like in the screenshot above (in some terminals), even from
- HTTP(S) URLs (use `--local` to disable remote images)
-* Jump marks for headings (in iTerm2 jump forwards and backwards with
- <key>⇧⌘↓</key> and <key>⇧⌘↑</key>)
+* nicely renders all basic CommonMark syntax (no [tables][GH-2] or [footnotes][GH-1] though),
+* highlights code blocks with [syntect],
+* shows [links][osc8] and images inline in supported terminals (see above, where "Pixabay" is a clickable link!),
+* adds jump marks for headings in [iTerm2] (jump forwards and backwards with
+ <key>⇧⌘↓</key> and <key>⇧⌘↑</key>).
| Terminal | Basic syntax | Syntax highlighting | Links | Images | Jump marks |
| :---------------------- | :-----------: | :-----------------: | :---: | :----: | :--------: |
@@ -53,9 +50,11 @@ terminal font which includes italic characters. It supports
Not supported:
-* CommonMark extensions: Footnotes and Tables
-* Re-filling paragraphs
+* CommonMark extensions: [Footnotes][GH-1] and [tables][GH-2]
+* [Re-filling paragraphs][GH-4]
+[syntect]: https://github.com/trishume/syntect
+[osc8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
[Terminology]: http://terminolo.gy
[ConEmu]: https://conemu.github.io