|
7 | 7 | #+HTML_HEAD: <link href="theme/org-nav-theme.css" rel="stylesheet"> |
8 | 8 | #+HTML_HEAD: <script src="theme/org-nav-theme.js"></script> |
9 | 9 |
|
10 | | -*This repo is a fork of the original [[https://github.com/caiorss/org-wiki][org-wiki]]* The plan for this fork is to |
11 | | -extend the original org-wiki to make it the Emacs(-lisp) equivalent of the great |
12 | | -[[https://zim-wiki.org/][zim-wiki]]. |
13 | | - |
14 | | -** Changelog (changes/additions from original) |
15 | | - - automatically create/sync index from existing wiki pages files |
| 10 | +*This repo is a fork of the original [[https://github.com/caiorss/org-wiki][org-wiki]] by caiorss.* The plan for this |
| 11 | +fork is to extend the original org-wiki to make it the Emacs(-lisp) equivalent |
| 12 | +of the great [[https://zim-wiki.org/][zim]] desktop wiki software (but even nicer). |
| 13 | + |
| 14 | +[[https://github.com/caiorss/org-wiki][org-wiki]] offers a nice starter "template" for the project. However, that package |
| 15 | +is a little outdated and it requires an update to make it use more modern tools |
| 16 | +like [[https://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.html][org-publish]], [[https://github.com/alphapapa/org-ql][org-ql]]/[[https://github.com/alphapapa/org-rifle][org-rifle]], [[https://github.com/alphapapa/org-sidebar][org-sidebar]]/[[https://github.com/toshism/org-super-links][org-super-links]] etc. Also I |
| 17 | +would prefer it uses Emacs lisp tools, like [[https://github.com/skeeto/skewer-mode][skewer-modee]] or [[https://github.com/skeeto/impatient-mode][impatient-mode]], to |
| 18 | +serve website previews. |
| 19 | + |
| 20 | +** Motivation |
| 21 | + Org-mode is an amazing personal management and note taking system. However, |
| 22 | + its flexibility makes it a little overwhelming to decide on a good way to |
| 23 | + structure the system. |
| 24 | + |
| 25 | +After researching different options, like [[https://www.orgroam.com/][org-roam]], [[org-brain]] etc., I concluded |
| 26 | +that actually I would prefer a simple and straightforward design like that of |
| 27 | +the [[https://zim-wiki.org/][zim]] desktop wiki software. Org actually provides a very similar design when |
| 28 | +using single org files as equivalent to [[https://zim-wiki.org/manual/Help/Notebooks.html][zim notebooks]]. However using a single |
| 29 | +org file per notebook has some drawbacks. |
| 30 | + |
| 31 | +*** Slow |
| 32 | +Unfortunately org quickly becomes really slow (I have a single note file with |
| 33 | +only 72 main headings and 413 total headings and it already takes more than 10 |
| 34 | +seconds to just open it). This is one reason to break up the single file in |
| 35 | +multiple files. |
| 36 | + |
| 37 | +*** Publishing with org-publish |
| 38 | +I would love to share many of my notes and articles. However, to publish the |
| 39 | +single note file with a nice website structure, it is again a good strategy to |
| 40 | +break up the single note file in multiple files. In this way it can be made |
| 41 | +compatible with [[https://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.html][org-publish]] and [[https://juanjose.garciaripoll.com/blog/org-mode-html-templates/index.html][org-thtml]] (which makes it possible to create org |
| 42 | +exporters for css-frameworks, like in my experiment [[https://gitlab.com/flonic/org-blog][here]] where I extended |
| 43 | +[[https://juanjose.garciaripoll.com/blog/org-mode-html-templates/index.html][ox-thtml]] into the [[https://gitlab.com/flonic/org-blog/-/blob/master/ox-bulma.el][ox-bulma]] exporter, an (unfinished) example page can be found |
| 44 | +[[https://flonic.gitlab.io/org-blog/blog/emacs-transient-tutorial/index.html][here]]. I guess in the end the =org-wiki= could replace the [[https://gitlab.com/dalanicolai/easy-thtml][easy-thtml]] package |
| 45 | +(which is a very basic start to "port" the [[https://github.com/masasam/emacs-easy-hugo][easy-hugo]] package to =org-thtmtl=). |
| 46 | + |
| 47 | + |
| 48 | +** Changelog (changes/additions w.r.t. original org-wiki) |
| 49 | + - automatically create/sync index from existing wiki pages files (to leave the |
| 50 | + structure of the index intact, the "index updater" which produces a |
| 51 | + structure as found in the file system, will be replaced by an "index |
| 52 | + checker" which uses =cl-set-difference= to find differences with files on |
| 53 | + disk, but leaves the index structure intact) |
16 | 54 | - add deletion command |
17 | 55 | - add find page command using completion-read (compatible with most completion |
18 | 56 | frameworks like ivy, selectrum etc.) |
|
0 commit comments