From 451bc567e26850a4022e05d48b8ecef85e1c4bbb Mon Sep 17 00:00:00 2001 From: Akbar Rahman Date: Tue, 2 Jan 2024 04:19:15 +0000 Subject: [PATCH] update readme --- readme.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 9180234..10a5034 100644 --- a/readme.md +++ b/readme.md @@ -10,8 +10,9 @@ Tested with [pandoc v2.19.2](https://github.com/jgm/pandoc/releases/tag/2.19.2). ## Why? - View notes as a website, on any device -- Write notes with Pandoc markdown - Easily share notes +- Powered by Pandoc, and therefore supports [Pandoc's markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) (I mainly care about equations) +- [flatnotes](https://github.com/Dullage/flatnotes) is cool but I really would rather type my notes in Vim - Lightweight HTML generated - Minimal JavaScript @@ -28,7 +29,7 @@ Tested with [pandoc v2.19.2](https://github.com/jgm/pandoc/releases/tag/2.19.2). - gronk looks for the plaintext file `LICENSE` in the root directory of your notes -## Custom Directory Index +## Custom Directory Index and Metadata To add custom content to a directory index, put it in a file called `index.md` under the directory. @@ -115,5 +116,3 @@ Then you just have to point a webserver at `output-dir`. Default synatx highlighting is based off [Pygments](https://pygments.org/)' default theme and made using Pandoc v2.7.2. I found the theme [here](https://github.com/tajmone/pandoc-goodies/blob/master/skylighting/css/built-in-styles/pygments.css). - -Pretty sure the link colours are taken from [thebestmotherfucking.website](https://thebestmotherfucking.website/).