Wiki

You're reading the wiki right now. The wiki is hosted at https://ides.club/wiki/ and is editable by everyone on the server.

The wiki itself is a collection of markdown files which are rendered as html files by a simple static generator named quickblog.

The files themselves are stored in a git repository hosted on the server's local git server. The project is trefulo/wiki. To get started, goto your home directory and clone the project with

git clone git@git.ides.club:trefulo/wiki.git

then you'll have a ~/wiki directory with all of the source files.

To make a new post use:

bb quickblog new --file flname.md --title Title

And edit it appropriately.

make render

Will render the pages and put them in ~/wiki/public/ which you can easily view with make watch. In fact make watch will automatically look for changes and re-compile the wiki, and will make it temporarily available at https://ides.club:1888 so you can check your edits in real time.

Once you are satisfied you can use

make publish

to copy the completed changes to the /srv/wiki/ directory which serves as the public endpoint for https://ides.club/wiki/

Published: 2022-11-23

Tagged: services