alvierahman90/gronk
1
0
Fork 0
mirror of https://github.com/alvierahman90/gronk.git synced 2024-11-22 07:19:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme on markdown

Browse Source
This commit is contained in:
Akbar Rahman 2022-04-03 22:44:17 +01:00
parent 496216568e
commit 9e58be3a01
Signed by: alvierahman90
GPG Key ID: 20609519444A1269
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
readme.md
View File

@ -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 - `tags` --- A YAML list of tags which the article relates to - this is used for browsing and also
searching searching
- `title` --- The title of the article - `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 - notes2web indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for
searching 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 This is optional but if you would like to add a license you can find one
[here](https://choosealicense.com). [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 ## CLI Usage
``` ```