dotfiles/emacs/modules/tools/wiki/README.org
2021-05-06 14:28:37 +08:00

38 lines
1.0 KiB
Org Mode

#+title: tools/wiki
#+date: "2021-05-05 00:27:26 +08:00"
#+date_modified: "2021-05-05 01:52:39 +08:00"
#+language: en
* Description
This module set up my personal wiki configuration with Emacs primarily with org-roam.
The setup uses org-roam v2.
** Module flags
- ~+anki~ enables Anki cards editing with [[https://github.com/louietan/anki-editor/][anki-editor]].
- ~+markdown~ adds Markdown support in org-roam.
- ~+dendron~ adds [[https://dendron.so/][Dendron]]-inspired features with [[https://github.com/vicrdguez/dendroam][dendroam]].
** 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]]
* 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]].