wiki

Wiki for sbi.re
Log | Files | Refs | Submodules | README

README.md (826B)


1wiki for various sbi.re services
2
3## How to build
4
5This wiki is made with `achille`. In order to build the `wiki`
6executable locally, do the following:
7
8```
9git clone --recurse-submodules git@sbi.re:wiki
10cd wiki
11cabal install --overwrite-policy=always
12```
13
14## Generating the static wiki
15
16After building the `wiki` executable, you can generate the wiki by running:
17
18```
19wiki build
20```
21
22You will need `git` and `sort` in `PATH`.
23
24## TODO
25
26- Improve template engine
27- Make our very own markup language
28- Add configuration CLI flags (maybe to achille directly)
29- Link every wiki page to source & history
30- Setup hook on radon to build directly on the server
31- Zettelkasten-like linking
32  - `UID`: Not something random but the actual path (ex: `services/git` for
33    `wiki/services/git.md`)
34- Vim plugin + fzf search for the above