You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
Mickaël Menu 87b5201583
Explain how to use the tags in the documentation
3 years ago
adapter Save additional metadata in the database (#7) 3 years ago
cmd Add a [format.markdown] config section to customize tags syntax 3 years ago
core Use the YAML frontmatter key `date` for the note creation date, when provided 3 years ago
docs Explain how to use the tags in the documentation 3 years ago
util Expose environment variables to note templates with the new {{env}} variable 3 years ago
.gitattributes Improve README 3 years ago
.gitignore Add doc pages 3 years ago
CHANGELOG.md Use the YAML frontmatter key `date` for the note creation date, when provided 3 years ago
LICENSE Initial commit 3 years ago
README.md Filter notes by tags (#6) 3 years ago
go Add a screencast to the README 3 years ago
go.mod Use the YAML frontmatter key `date` for the note creation date, when provided 3 years ago
go.sum Use the YAML frontmatter key `date` for the note creation date, when provided 3 years ago
main.go Save additional metadata in the database (#7) 3 years ago

README.md

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.

It is primarily focused on:

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.

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

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