seam

Personal wiki toolkit for Emacs
Log | Files | Refs | LICENSE

README.org (1993B)

      1 ** A personal wiki toolkit for Emacs
      2 
      3 [[https://wiki.plexwave.org/seam][Seam]] leverages the power of [[https://orgmode.org/][Org mode]] to make creating, linking, and
      4 publishing your notes easier.  It is geared particularly towards
      5 creating a personal wiki — a place where you can share some portion of
      6 your notes with the world.  It takes inspiration from the likes of
      7 [[https://obsidian.md/][Obsidian]] and [[https://www.mediawiki.org/wiki/MediaWiki][MediaWiki]].
      8 
      9 Three of Seam's key design tenets are:
     10 
     11 - Org files and their resultant HTML files should always be kept in
     12   sync.
     13 
     14 - It should be easy to create multiple sites using different subsets
     15   of the same note collection.
     16 
     17 - Notes should not be unnecessarily clouded with metadata.
     18 
     19 Be aware that Seam is a fully self-contained package, and is not
     20 likely to be compatible with things like [[https://www.orgroam.com/][Org-roam]] due to its vastly
     21 different approach.
     22 
     23 *Note:* Requires Emacs 29+, Org 9.6+, and [[https://github.com/Wilfred/mustache.el][mustache.el]].
     24 
     25 *** Getting started
     26 
     27 The easiest way to begin is to follow the brief [[https://wiki.plexwave.org/seam-tutorial][tutorial]].
     28 
     29 *** Documentation
     30 
     31 Seam's manual is still being written.  In the meantime, the [[https://wiki.plexwave.org/seam][project
     32 page]] contains some more tidbits you might find useful.
     33 
     34 I have endeavored to make Seam fairly self-documenting, so check the
     35 docstrings and the Seam customization group when in any doubt.
     36 
     37 *** Known issues
     38 
     39 - =find-file= does not create notes properly.  You should use
     40   =seam-find-note= instead.
     41 
     42 - Commented-out links are not ignored, e.g. for determining backlinks.
     43 
     44 - Tags in note title headlines are not ignored; they are treated as
     45   part of the title.
     46 
     47 - =seam:= links /must/ have a description.  Bare links are not
     48   supported.
     49 
     50 *** Upgrading
     51 
     52 As a new project, Seam is very much in flux.  Whenever you upgrade it,
     53 please see the [[file:CHANGELOG.org][changelog]] for breaking changes, new features, etc.