README
¶
Zettelstore
Zettelstore is a software that collects and relates your notes (“zettel”) to represent and enhance your knowledge. It helps with many tasks of personal knowledge management by explicitly supporting the Zettelkasten method. The method is based on creating many individual notes, each with one idea or information, that are related to each other. Since knowledge is typically build up gradually, one major focus is a long-term store of these notes, hence the name “Zettelstore”.
To get an initial impression, take a look at the manual. It is a live example of the zettelstore software, running in read-only mode.
Zettelstore Client provides client software to access Zettelstore via its API more easily, Zettelstore Contrib contains contributed software, which often connects to Zettelstore via its API. Some of the software packages may be experimental.
The software, including the manual, is licensed under the European Union Public License 1.2 (or later).
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ast provides the abstract syntax tree for parsed zettel content.
|
Package ast provides the abstract syntax tree for parsed zettel content. |
|
Package auth provides services for authentification / authorization.
|
Package auth provides services for authentification / authorization. |
|
cred
Package cred provides some function for handling credentials.
|
Package cred provides some function for handling credentials. |
|
impl
Package impl provides services for authentification / authorization.
|
Package impl provides services for authentification / authorization. |
|
policy
Package policy provides some interfaces and implementation for authorizsation policies.
|
Package policy provides some interfaces and implementation for authorizsation policies. |
|
Package box provides a generic interface to zettel boxes.
|
Package box provides a generic interface to zettel boxes. |
|
compbox
Package compbox provides zettel that have computed content.
|
Package compbox provides zettel that have computed content. |
|
constbox
Package constbox puts zettel inside the executable.
|
Package constbox puts zettel inside the executable. |
|
dirbox
Package dirbox provides a directory-based zettel box.
|
Package dirbox provides a directory-based zettel box. |
|
filebox
Package filebox provides boxes that are stored in a file.
|
Package filebox provides boxes that are stored in a file. |
|
manager
Package manager coordinates the various boxes and indexes of a Zettelstore.
|
Package manager coordinates the various boxes and indexes of a Zettelstore. |
|
manager/mapstore
Package mapstore stored the index in main memory via a Go map.
|
Package mapstore stored the index in main memory via a Go map. |
|
manager/store
Package store contains general index data for storing a zettel index.
|
Package store contains general index data for storing a zettel index. |
|
membox
Package membox stores zettel volatile in main memory.
|
Package membox stores zettel volatile in main memory. |
|
notify
Package notify provides some notification services to be used by box services.
|
Package notify provides some notification services to be used by box services. |
|
Package cmd provides command generic functions.
|
Package cmd provides command generic functions. |
|
zettelstore
Package main is the starting point for the zettelstore command.
|
Package main is the starting point for the zettelstore command. |
|
Package collect provides functions to collect items from a syntax tree.
|
Package collect provides functions to collect items from a syntax tree. |
|
Package config provides functions to retrieve runtime configuration data.
|
Package config provides functions to retrieve runtime configuration data. |
|
Package encoder provides a generic interface to encode the abstract syntax tree into some text form.
|
Package encoder provides a generic interface to encode the abstract syntax tree into some text form. |
|
htmlenc
Package htmlenc encodes the abstract syntax tree into HTML5 via zettelstore-client.
|
Package htmlenc encodes the abstract syntax tree into HTML5 via zettelstore-client. |
|
mdenc
Package mdenc encodes the abstract syntax tree back into Markdown.
|
Package mdenc encodes the abstract syntax tree back into Markdown. |
|
shtmlenc
Package shtmlenc encodes the abstract syntax tree into a s-expr which represents HTML.
|
Package shtmlenc encodes the abstract syntax tree into a s-expr which represents HTML. |
|
szenc
Package szenc encodes the abstract syntax tree into a s-expr for zettel.
|
Package szenc encodes the abstract syntax tree into a s-expr for zettel. |
|
textenc
Package textenc encodes the abstract syntax tree into its text.
|
Package textenc encodes the abstract syntax tree into its text. |
|
zmkenc
Package zmkenc encodes the abstract syntax tree back into Zettelmarkup.
|
Package zmkenc encodes the abstract syntax tree back into Zettelmarkup. |
|
Package encoding provides helper functions for encodings.
|
Package encoding provides helper functions for encodings. |
|
atom
Package atom provides an Atom encoding.
|
Package atom provides an Atom encoding. |
|
rss
Package rss provides a RSS encoding.
|
Package rss provides a RSS encoding. |
|
xml
Package xml provides helper for a XML-based encoding.
|
Package xml provides helper for a XML-based encoding. |
|
Package evaluator interprets and evaluates the AST.
|
Package evaluator interprets and evaluates the AST. |
|
Package kernel provides the main kernel service.
|
Package kernel provides the main kernel service. |
|
impl
Package impl provides the kernel implementation.
|
Package impl provides the kernel implementation. |
|
Package logger implements a logging package for use in the Zettelstore.
|
Package logger implements a logging package for use in the Zettelstore. |
|
Package parser provides a generic interface to a range of different parsers.
|
Package parser provides a generic interface to a range of different parsers. |
|
blob
Package blob provides a parser of binary data.
|
Package blob provides a parser of binary data. |
|
cleaner
Package cleaner provides functions to clean up the parsed AST.
|
Package cleaner provides functions to clean up the parsed AST. |
|
draw
Package draw provides a parser to create SVG from ASCII drawing.
|
Package draw provides a parser to create SVG from ASCII drawing. |
|
markdown
Package markdown provides a parser for markdown.
|
Package markdown provides a parser for markdown. |
|
none
Package none provides a none-parser, e.g.
|
Package none provides a none-parser, e.g. |
|
plain
Package plain provides a parser for plain text data.
|
Package plain provides a parser for plain text data. |
|
zettelmark
Package zettelmark provides a parser for zettelmarkup.
|
Package zettelmark provides a parser for zettelmarkup. |
|
Package query provides a query for zettel.
|
Package query provides a query for zettel. |
|
Package strfun provides some string functions.
|
Package strfun provides some string functions. |
|
Package tools provides a collection of functions to build needed tools.
|
Package tools provides a collection of functions to build needed tools. |
|
build
Package main provides a command to build and run the software.
|
Package main provides a command to build and run the software. |
|
check
Package main provides a command to execute unit tests.
|
Package main provides a command to execute unit tests. |
|
clean
Package main provides a command to clean / remove development artifacts.
|
Package main provides a command to clean / remove development artifacts. |
|
devtools
Package main provides a command to install development tools.
|
Package main provides a command to install development tools. |
|
testapi
Package main provides a command to test the API
|
Package main provides a command to test the API |
|
Package usecase provides (business) use cases for the zettelstore.
|
Package usecase provides (business) use cases for the zettelstore. |
|
web
|
|
|
adapter
Package adapter provides handlers for web requests, and some helper tools.
|
Package adapter provides handlers for web requests, and some helper tools. |
|
adapter/api
Package api provides api handlers for web requests.
|
Package api provides api handlers for web requests. |
|
adapter/webui
Package webui provides web-UI handlers for web requests.
|
Package webui provides web-UI handlers for web requests. |
|
content
Package content manages content handling within the web package.
|
Package content manages content handling within the web package. |
|
server
Package server provides the Zettelstore web service.
|
Package server provides the Zettelstore web service. |
|
server/impl
Package impl provides the Zettelstore web service.
|
Package impl provides the Zettelstore web service. |
|
Package zettel provides specific types, constants, and functions for zettel.
|
Package zettel provides specific types, constants, and functions for zettel. |
|
id
Package id provides zettel specific types, constants, and functions about zettel identifier.
|
Package id provides zettel specific types, constants, and functions about zettel identifier. |
|
meta
Package meta provides the zettel specific type 'meta'.
|
Package meta provides the zettel specific type 'meta'. |
Click to show internal directories.
Click to hide internal directories.