alvierahman90/notes2web
Archived
1
1
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Akbar Rahman 2021-08-21 03:20:23 +01:00
parent 56688b26f5
commit 1d9245fb8f
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
readme.md
View File

@ -28,7 +28,18 @@ doing it for me:
1. Run `make install` as root 1. Run `make install` as root
## Usage ## Things to Remember Whilst Writing Notes
- notes2web reads the following YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) variable:
- `author` --- The person(s) who wrote the article
- `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
- notes2web indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for searching
- notes2web attempts to display file history through the `git log` command
## CLI Usage
``` ```
$ notes2web.py notes_directory $ notes2web.py notes_directory