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 piece of information, which are related to each other. Since knowledge is typically built up gradually, one major focus is the long-term storage 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 cmd provides the commands to call Zettelstore from the command line.
|
Package cmd provides the commands to call Zettelstore from the command line. |
|
zettelstore
command
Package main is the starting point for the zettelstore command.
|
Package main is the starting point for the zettelstore command. |
|
internal
|
|
|
ast
Package ast provides the abstract syntax tree for parsed zettel content.
|
Package ast provides the abstract syntax tree for parsed zettel content. |
|
auth
Package auth provides services for authentification / authorization.
|
Package auth provides services for authentification / authorization. |
|
auth/impl
Package impl provides services for authentification / authorization.
|
Package impl provides services for authentification / authorization. |
|
auth/policy
Package policy provides some interfaces and implementation for authorizsation policies.
|
Package policy provides some interfaces and implementation for authorizsation policies. |
|
box
Package box provides a generic interface to zettel boxes.
|
Package box provides a generic interface to zettel boxes. |
|
box/compbox
Package compbox provides zettel that have computed content.
|
Package compbox provides zettel that have computed content. |
|
box/constbox
Package constbox puts zettel inside the executable.
|
Package constbox puts zettel inside the executable. |
|
box/dirbox
Package dirbox provides a directory-based zettel box.
|
Package dirbox provides a directory-based zettel box. |
|
box/filebox
Package filebox provides boxes that are stored in a file.
|
Package filebox provides boxes that are stored in a file. |
|
box/manager
Package manager coordinates the various boxes and indexes of a Zettelstore.
|
Package manager coordinates the various boxes and indexes of a Zettelstore. |
|
box/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. |
|
box/manager/store
Package store contains general index data for storing a zettel index.
|
Package store contains general index data for storing a zettel index. |
|
box/membox
Package membox stores zettel volatile in main memory.
|
Package membox stores zettel volatile in main memory. |
|
box/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. |
|
collect
Package collect provides functions to collect items from a syntax tree.
|
Package collect provides functions to collect items from a syntax tree. |
|
config
Package config provides functions to retrieve runtime configuration data.
|
Package config provides functions to retrieve runtime configuration data. |
|
encoder
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. |
|
evaluator
Package evaluator interprets and evaluates the AST.
|
Package evaluator interprets and evaluates the AST. |
|
kernel
Package kernel provides the main kernel service.
|
Package kernel provides the main kernel service. |
|
logging
Package logging provides some definitions to adapt package slog to Zettelstore needs
|
Package logging provides some definitions to adapt package slog to Zettelstore needs |
|
parser
Package parser provides a generic interface to a range of different parsers.
|
Package parser provides a generic interface to a range of different parsers. |
|
query
Package query provides a query for zettel.
|
Package query provides a query for zettel. |
|
usecase
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. |
|
web/adapter/api
Package api provides api handlers for web requests.
|
Package api provides api handlers for web requests. |
|
web/adapter/webui
Package webui provides web-UI handlers for web requests.
|
Package webui provides web-UI handlers for web requests. |
|
web/content
Package content manages content handling within the web package.
|
Package content manages content handling within the web package. |
|
web/server
Package server provides the Zettelstore web service.
|
Package server provides the Zettelstore web service. |
|
zettel
Package zettel provides specific types, constants, and functions for zettel.
|
Package zettel provides specific types, constants, and functions for zettel. |
|
Package tools provides a collection of functions to build needed tools.
|
Package tools provides a collection of functions to build needed tools. |
|
build
command
Package main provides a command to build and run the software.
|
Package main provides a command to build and run the software. |
|
check
command
Package main provides a command to execute unit tests.
|
Package main provides a command to execute unit tests. |
|
clean
command
Package main provides a command to clean / remove development artifacts.
|
Package main provides a command to clean / remove development artifacts. |
|
devtools
command
Package main provides a command to install development tools.
|
Package main provides a command to install development tools. |
|
htmllint
command
Package main provides a tool to check the validity of HTML zettel documents.
|
Package main provides a tool to check the validity of HTML zettel documents. |
|
testapi
command
Package main provides a command to test the API
|
Package main provides a command to test the API |
Click to show internal directories.
Click to hide internal directories.