aboutsummaryrefslogtreecommitdiff

1. A personal wiki toolkit for Emacs

Seam leverages the power of Org mode to make creating, linking, and exporting your notes easier. It is geared particularly towards creating a personal wiki — a place where you can share some portion of your notes with the world. It takes inspiration from the likes of Obsidian and MediaWiki.

Three of Seam's key design tenets are:

  • Org files and their resultant HTML files should always be kept in sync.
  • It should be easy to create multiple sites using different subsets of the same note collection.
  • Notes should not be unnecessarily clouded with metadata.

Be aware that Seam is a fully self-contained package, and is not likely to be compatible with things like Org-roam due to its vastly different approach.

Note: Requires Emacs 29 or greater, with Org 9.6 or greater.

1.1. Getting started

The easiest way to begin is to follow the brief tutorial.

1.2. Documentation

Seam's manual is still being written. In the meantime, the project page contains some more tidbits you might find useful.

I have endeavored to make Seam fairly self-documenting, so check the docstrings and the Seam customization group when in any doubt.

1.3. Known issues

  • find-file does not create notes properly. You should use seam-find-note instead.
  • Commented-out links are not ignored, e.g. for determining backlinks.
  • Tags in note title headlines are not ignored; they are treated as part of the title.
  • seam: links must have a description. Bare links are not supported.

1.4. Upgrading

As a new project, Seam is very much in flux. Whenever you upgrade it, please see the changelog for breaking changes, new features, etc.