alvierahman90/notes2web
Archived
1
1
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity
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.
13 Commits 4 Branches 0 Tags 1.1 MiB
JavaScript 71.4%
Python 16.9%
HTML 6%
CSS 5.1%
Makefile 0.6%
dd134e2cba
Go to file
Alvie Rahman dd134e2cba improve spacing and comments
2021-05-01 12:08:21 +01:00
templates add footer to templates 2021-05-01 12:00:01 +01:00
Makefile fix issues 2021-04-30 22:08:15 +01:00
notes2web improve spacing and comments 2021-05-01 12:08:21 +01:00
readme.md add yq depencency, screenshot 2021-05-01 12:04:45 +01:00
screenshot.png add yq depencency, screenshot 2021-05-01 12:04:45 +01:00
styles.css initial commit 2021-04-30 21:56:08 +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 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. Right now the only config available is name:

name="alv"

If the name is not set, the title is set to 'notes'.

Uninstall

# make uninstall