https://github.com/vifon/zettel-mode

A Zettelkasten-style note-taking helper
https://github.com/vifon/zettel-mode

emacs org-mode roam zettelkasten

Last synced: 29 days ago
JSON representation

A Zettelkasten-style note-taking helper

• Host: GitHub
• URL: https://github.com/vifon/zettel-mode
• Owner: vifon
• License: gpl-3.0
• Created: 2020-05-25T22:12:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-06-26T23:36:16.000Z (over 2 years ago)
• Last Synced: 2024-08-03T22:19:11.986Z (4 months ago)
• Topics: emacs, org-mode, roam, zettelkasten
• Language: Emacs Lisp
• Size: 106 KB
• Stars: 32
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - vifon/zettel-mode - A Zettelkasten-style note-taking helper (Emacs Lisp)

README

        
zettel-mode [name subject to change]

====================================

Note: Mostly superseded by

[zettel2](https://github.com/vifon/zettel2).  Left as a separate

project because the featureset is very different.

An opinionated Emacs mode for [Zettelkasten][1]-style note-taking.

Heavily inspired by [org-roam][2], striving to be simpler, less

dependent on the external state (like the auxiliary database of

`org-roam`) and local only to the affected files (i.e. no global minor

modes).

ASSUMPTIONS

-----------

Traditionally uses [Deft][3] as its "entry point" and was initially

developed under an assumption the `Deft` files reside in `~/.deft/`.

It should work with any `deft-directory` but you'll need to customize

`auto-mode-alist` accordingly.  Using subdirectories isn't supported.

It's possible to have secondary Zettelkastens outside of `~/.deft/`,

or ignore Deft whatsoever by handling `auto-mode-alist` manually, for example:

```elisp

;;; Any .org file inside a zettel/ or zettels/ directory.

(add-to-list 'auto-mode-alist '("/zettels?/[^/]+\\.org\\'" . zettel-mode))

(add-to-list 'auto-mode-alist '("/home/USER/my-zettelkasten/[^/]+\\.org\\'" . zettel-mode))

```

To prevent `zettel-mode` from associating with the Deft files, eval

`(setq zettel-mode-no-deft t)` before loading `zettel-mode`.

[1]: https://zettelkasten.de/

[2]: https://github.com/org-roam/org-roam

[3]: https://github.com/jrblevin/deft

FEATURES

--------

- Quick new note creation: select some text and press C-c C-l.

- A sidebar with lists of references to and from the current file.

- A fully optional reference and backreference cache (rebuilt with `make(1)`).

For the settings see the provided [Customize][4] menus.

[4]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Easy-Customization.html

SCRIPTS

-------

In the `scripts/` directory reside some helper scripts for common

maintenance tasks for the notes.  In general they work but they

probably don't handle all the corner cases (like filenames with

special characters).  Each script has a brief description included as

a comment.

FAQ

---

Q: Why it's not on MELPA?

A: I don't want to hoard such a generic name as `zettel-mode` and for

now I don't have a better name for it either.

COPYRIGHT

---------

Copyright (C) 2020  Wojciech Siewierski

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see .