kaorahi / howm

note-taking tool on Emacs
GNU General Public License v2.0
90 stars 6 forks source link
emacs emacs-lisp note-taking notes wiki

howm: Write fragmentarily and read collectively.

Howm is a note-taking tool on Emacs. It is similar to emacs-wiki.el; you can enjoy hyperlinks and full-text search easily. It is not similar to emacs-wiki.el; it can be combined with any format.

The following screenshot illustrates the Howm linking system: screenshot

(Colorscheme: Modus themes.)

Quick start

If you're using a recent version of Emacs and have enabled the MELPA community package repository, you can simply place the following in your ~/.config/emacs/init.el configuration file and restart Emacs:

(use-package howm
  :ensure t)

After that, you can press e.g. C-c , , to open the main menu, C-c , a to see a list of all your notes, or C-c , c to capture a new note from anywhere. See the documentation links above for more detailed instructions on how to use Howm.

By default, notes are stored in plaintext *.txt format in the folder ~/howm. However, it is possible to write notes in markdown-mode (must be installed separately) and save these files elsewhere. Below is a simple example:

(use-package howm
  :ensure t
  :init
  ;; Where to store the files?
  (setq howm-directory "~/Documents/Howm")
  (setq howm-home-directory howm-directory)
  ;; What format to use for the files?
  (setq howm-file-name-format "%Y-%m-%d-%H%M%S.md")
  (setq howm-view-title-header "#"))

Alternatively, if you prefer integrating with e.g. Org-mode (just replace C-c , with C-c ; in Howm's documentation):

(use-package howm
  :ensure t
  :init
  ;; Where to store the files?
  (setq howm-directory "~/Documents/Howm")
  (setq howm-home-directory howm-directory)
  ;; What format to use for the files?
  (setq howm-file-name-format "%Y-%m-%d-%H%M%S.org")
  (setq howm-view-title-header "*")
  (setq howm-dtime-format "<%Y-%m-%d %a %H:%M>")
  ;; Avoid conflicts with Org-mode by changing Howm's prefix from "C-c ,".
  (setq howm-prefix (kbd "C-c ;"))
  :bind*
  ;; Conveniently open the Howm menu with "C-c ; ;".
  ("C-c ; ;" . howm-menu))

Project history