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

Update readme

Browse Source
This commit is contained in:
Akbar Rahman 2021-09-01 13:34:19 +01:00
parent 6f6df5fd07
commit d9035f6f2f
Signed by: alvierahman90
GPG Key ID: 20609519444A1269
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
readme.md
View File

@ -15,6 +15,7 @@ doing it for me:
- It was annoying to sync to my phone - It was annoying to sync to my phone
- PDFs do not scale so they were hard to read on smaller screens - PDFs do not scale so they were hard to read on smaller screens
- Probably more reasons I can't think of right now - Probably more reasons I can't think of right now
- Fun
## Install ## Install
@ -33,10 +34,12 @@ doing it for me:
- notes2web reads the following YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) variable: - notes2web reads the following YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) variable:
- `author` --- The person(s) who wrote the article - `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 - `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 - `title` --- The title of the article
- notes2web indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for searching - 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 - notes2web attempts to display file history through the `git log` command
## CLI Usage ## CLI Usage