Archived

View your notes as a static html site. https://notes.alv.cx

This repository has been archived on 2024-01-02. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Alvie Rahman 02246ff26e add --clean switch		2021-05-01 13:37:57 +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	generate website in separate folder	2021-05-01 13:37:23 +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

Install Pandoc and yq

On arch:
```
# pacman -S pandoc yq
```
Run make install as root

Usage

$ notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]

The command will generate and place html files in your notes directory. It will then generate a list of all note files and put it in index.html in the root directory.

Then you just have to point a webserver at your notes directory.

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