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

add yq depencency, screenshot

Browse Source
This commit is contained in:
Akbar Rahman 2021-05-01 12:04:45 +01:00
parent e508bccea7
commit aea3ce7422
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
readme.md
View File

@ -2,15 +2,23 @@
View your notes as a static html site.
![](./screenshot.png)
## Install
0. Install [Pandoc](https://pandoc.org/index.html)
0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq)
On arch:
```
# pacman -S pandoc yq
```
1. Run `make install` as root
## Usage
```
notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]
$ notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]
```
The command will generate and place html files in your notes directory.

BIN
screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 198 KiB