firmart / org-glaux

Glaux (γλαῦξ) is a personal wiki using the wiseness of org-mode.

Org-glaux

Glaux (γλαῦξ) is a personal wiki using the wiseness of org-mode.

Features

Support …

• backward navigation (org-glaux-navi-back)
• sub-directories file hierarchy
• dead wiki link highlighting
• edit history (with git + automatic commit)
• wiki statistics
• And more…

Installation

Before this package get into MELPA, there are two alternatives to install org-glaux : manually or with quelpa-use-package. The recommended configuration can be found below.

Manual

• git clone https://github.com/firmart/git-glaux ~/.emacs.d/lisp/git-glaux

(use-package org-glaux
    :pin manual
    :load-path "lisp/org-glaux/"
    :bind ("C-c w" . org-glaux-index)
    :config 
    ;; Wikis location. default: '("~/org/wiki")
    (setq org-glaux-location-list '("~/Org/wiki" "~/Org/wiki2")) 
    ;; Destination to generate backup. default: nil
    (setq org-glaux-backup-location "~/Org/wiki/index/")
    ;; Enable org-glaux menu. Optional.
    (org-glaux-menu-enable))

quelpa-use-package

• M-x package-install RET quelpa-use-package RET
• Make sure you have (require 'quelpa) and (require 'quelpa-use-package) somewhere in your configuration (or equivalently with use-package).

(use-package org-glaux
  :quelpa (org-glaux :repo "firmart/org-glaux" :fetcher github)
  :config
  ;; Wikis location. default: '("~/org/wiki")
  (setq org-glaux-location-list '("~/Org/wiki" "~/Org/wiki2")) 
  ;; Destination to generate backup. default: nil
  (setq org-glaux-backup-location "~/Org/wiki/index/")
  ;; Enable org-glaux menu. Optional.
  (org-glaux-menu-enable)) 

Link formats

Wiki-links are in Wikipedia-style.

Link	To
wiki:path/to/<pagename>	Absolute path: <org-glaux-location>/path/to/<pagename>
wiki:/<pagename>	Child page: <current_page>/<pagename>
wiki:../	Parent page
wiki:../<pagename>	Sibling page

Known issues

Category	Issue
vc	Performance issue during org-glaux-vc-git-full-commit
link	http, https, and file links :face property is (over)written
core	Rename, move pages, and fix internal links to keep them valid
link	Some URL (e.g. Amazon) are mishighlighted due to url-file-exists-p.
stats	Performance issue during org-glaux--show-wiki-stats

TODOs

Category	Description
link	Show page description on point with tooltip
archive, link	Archive link with the wayback machine; access archived link if it’s a dead link
core	Support multi-line macro (builtin & custom)
image	Image gallery (using multi-line macro?)

Credits

org-glaux is based upon org-wiki of Caio Rodrigues.