Go to file
2021-03-14 17:20:01 +01:00
adapter Fix looking for mentions of a note with a title containing double quotes 2021-03-14 17:20:01 +01:00
cmd Add the --mention filtering option (#8) 2021-03-13 15:31:05 +01:00
core Add the --mention filtering option (#8) 2021-03-13 15:31:05 +01:00
docs Fix looking for mentions of a note with a title containing double quotes 2021-03-14 17:20:01 +01:00
util Expose environment variables to note templates with the new {{env}} variable 2021-03-11 21:18:29 +01:00
.gitattributes Improve README 2021-02-27 12:56:45 +01:00
.gitignore Add doc pages 2021-02-26 23:20:03 +01:00
CHANGELOG.md Release zk 0.2.0 2021-03-13 15:44:05 +01:00
go Add a screencast to the README 2021-02-28 21:00:23 +01:00
go.mod Use the YAML frontmatter key date for the note creation date, when provided 2021-03-12 19:48:20 +01:00
go.sum Use the YAML frontmatter key date for the note creation date, when provided 2021-03-12 19:48:20 +01:00
LICENSE Initial commit 2020-12-23 16:07:53 +01:00
main.go Save additional metadata in the database (#7) 2021-03-08 21:38:32 +01:00
README.md Update README 2021-03-14 15:11:59 +01:00

zk

A plain text note-taking assistant

Screencast

Looking for a quick usage example? Let's get started.

Description

zk is a command-line tool helping you to maintain a plain text Zettelkasten or personal wiki.

Highlights

See the changelog for the list of upcoming features waiting to be released.

What zk is not

  • A note editor.
  • A tool to serve your notes on the web for this, you may be interested in Neuron or Gollum.

Install

zk was only tested on macOS and Linux.

Build from scratch

Make sure you have a working Go installation, with Go's bin directory in your PATH.

$ git clone https://github.com/mickael-menu/zk.git
$ cd zk
$ chmod a+x go
$ ./go install
$ zk -h
  • Neuron a great tool to publish a Zettelkasten on the web
  • sirupsen's zk a collection of scripts with a similar purpose