dotfiles/emacs/modules/tools/wiki/README.org

#+title: tools/wiki
#+date: "2021-05-05 00:27:26 +08:00"
#+date_modified: "2021-05-21 11:12:10 +08:00"
#+language: en



* Description

This module set up my personal wiki configuration with Emacs primarily with org-roam.
Just like Emacs itself, tried my best to make it fully configurable.
The setup uses org-roam v2.


** Module flags

- ~+anki~ enables Anki cards editing with [[https://github.com/louietan/anki-editor/][anki-editor]].
- ~+biblio~ enables reference management with [[https://github.com/jkitchin/org-ref][org-ref]] and [[https://github.com/org-roam/org-roam-bibtex][org-roam-bibtex]].
- ~+dendron~ adds [[https://dendron.so/][Dendron]]-inspired features with [[https://github.com/vicrdguez/dendroam][dendroam]].
- ~+graph~ adds a graphical user interface for your notes.
- ~+markdown~ adds Markdown support in org-roam.


** Plugins

- [[https://github.com/org-roam/org-roam/][org-roam]] v2
- [[https://github.com/louietan/anki-editor/][anki-editor]]
- [[https://github.com/vicrdguez/dendroam][dendroam]]
- [[https://github.com/nobiot/md-roam][md-roam]]
- [[https://github.com/jkitchin/org-ref][org-ref]]
- [[https://github.com/org-roam/org-roam-bibtex][org-roam-bibtex]]
- [[https://github.com/org-roam/org-roam-ui][org-roam-ui]]




* Prerequisites

This module has a handful of requirements to work properly.

- SQLite v3 binary is installed in order for org-roam to work.
- The ~+anki~ feature requires Anki and the setup described from the [[https://github.com/louietan/anki-editor][project README]].
- ~+graph~ feature needs [[https://github.com/briandowns/simple-httpd][simple-httpd]] for the server to work.