alvierahman90/gronk
1
0
Fork 0
mirror of https://github.com/alvierahman90/gronk.git synced 2024-11-21 23:09:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
View your notes as a static HTML site.
21 Commits 4 Branches 0 Tags 1 MiB
JavaScript 67.2%
Python 19.4%
HTML 7.5%
CSS 4.9%
Dockerfile 0.6%
Other 0.4%
27d323ac84
Go to file
Alvie Rahman 27d323ac84 update readme to reflect website put in own folder
2021-05-01 13:40:38 +01:00
templates fix type 2021-05-01 13:22:17 +01:00
.notes2web.conf add development config 2021-05-01 13:05:22 +01:00
Makefile fix issues 2021-04-30 22:08:15 +01:00
notes2web add --clean switch 2021-05-01 13:37:57 +01:00
readme.md update readme to reflect website put in own folder 2021-05-01 13:40:38 +01:00
screenshot.png add yq depencency, screenshot 2021-05-01 12:04:45 +01:00
styles.css center figcaption 2021-05-01 13:02:47 +01:00

readme.md

notes2web

View your notes as a static html site.

Install

  1. Install Pandoc and yq

    On arch:

    # pacman -S pandoc yq

  2. Run make install as root

Usage

$ notes2web 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

notes2web looks for a config file called .notes2web.conf in your current directory and your home directory. Default config values:

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