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

add why? section to readme.md

Browse Source
This commit is contained in:
Akbar Rahman 2021-06-29 19:27:31 +01:00
parent da5aee0a49
commit 70d92e6d04
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

@ -4,6 +4,19 @@ View your notes as a static html site.
![](./screenshot.png) ![](./screenshot.png)
## Why?
I want to be able to view my notes in a more convenient way.
I was already writing them in Pandoc markdown and could view them as PDFs but that wasn't quite
doing it for me:
- It was inconvenient to flick through multiple files of notes to find the right PDF
- It was annoying to sync to my phone
- PDFs do not scale so they were hard to read on smaller screens
- Probably more reasons I can't think of right now
## Install ## Install
0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq) 0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq)