From 9e58be3a01467d58e83ba9cf78b3726adb2ee73b Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Sun, 3 Apr 2022 22:44:17 +0100 Subject: [PATCH] update readme on markdown --- readme.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/readme.md b/readme.md index 6d922e4..fa14bdd 100644 --- a/readme.md +++ b/readme.md @@ -37,6 +37,7 @@ doing it for me: - `tags` --- A YAML list of tags which the article relates to - this is used for browsing and also searching - `title` --- The title of the article + - `uuid` --- A unique identifier used for permalinks. More below. - notes2web indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for searching @@ -46,6 +47,18 @@ doing it for me: This is optional but if you would like to add a license you can find one [here](https://choosealicense.com). +### Permalinks + +Permalinks are currently rather basic and requires JavaScript to be enabled on the local computer. +In order to identify documents between file changes, a unique identifier is used to identify a file. + +This unique identifier can be generated using the `uuidgen` command in the `uuid-runtime` package or +`str(uuid.uuid())` in the `uuid` python package. + +The included `n2w_add_uuid.py` will add a UUID to a markdown file which does not have a UUID in it +already. +Combine it with `find` to UUIDify all your markdown files (but make a backup first). + ## CLI Usage ```