mirror of
https://github.com/alvierahman90/gronk.git
synced 2024-10-22 12:21:53 +00:00
55 lines
1.2 KiB
Markdown
55 lines
1.2 KiB
Markdown
# notes2web
|
|
|
|
View your notes as a static html site.
|
|
|
|
|
|
|
|
## Install
|
|
|
|
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.py NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]
|
|
```
|
|
|
|
The command will generate a website in the `$output` directory (`./web` by default).
|
|
It will then generate a list of all note files and put it in `index.html`.
|
|
|
|
Then you just have to point a webserver at `$output`.
|
|
|
|
## Config
|
|
|
|
NOT CURRENTLY IMPLEMENTED
|
|
|
|
`notes2web` looks for a config file called `.notes2web.conf` in your current directory and your home
|
|
directory.
|
|
Default config values:
|
|
|
|
```bash
|
|
name="" # your name
|
|
output="web" # the folder where the website will be generated in
|
|
article_template="/opt/notes2web/templates/article.html"
|
|
textarticlehead_template="/opt/notes2web/templates/textarticlehead.html"
|
|
textarticlefoot_template="/opt/notes2web/templates/textarticlefoot.html"
|
|
listitem_template="/opt/notes2web/templates/listitem.html"
|
|
index_template="/opt/notes2web/templates/index.html"
|
|
stylesheet="/opt/notes2web/styles.css"
|
|
```
|
|
|
|
If the name is not set, the title is set to 'notes'.
|
|
|
|
## Uninstall
|
|
|
|
```
|
|
# make uninstall
|
|
```
|