Go to file
2021-03-06 21:16:28 +01:00
adapter Parse tags in Markdown documents (#5) 2021-03-06 19:38:52 +01:00
cmd Separate multiple --extra variables with , instead of ; 2021-03-06 21:16:28 +01:00
core Parse tags in Markdown documents (#5) 2021-03-06 19:38:52 +01:00
docs Separate multiple --extra variables with , instead of ; 2021-03-06 21:16:28 +01:00
util Parse tags in Markdown documents (#5) 2021-03-06 19:38:52 +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 Separate multiple --extra variables with , instead of ; 2021-03-06 21:16:28 +01:00
go Add a screencast to the README 2021-02-28 21:00:23 +01:00
go.mod Support Markdown autolinking for external links 2021-02-12 19:34:04 +01:00
go.sum Support Markdown autolinking for external links 2021-02-12 19:34:04 +01:00
LICENSE Initial commit 2020-12-23 16:07:53 +01:00
main.go Rename every occurrence of "slip box" into "notebook" 2021-02-15 22:44:31 +01:00
README.md Add screencasts in the Getting Started page 2021-03-05 21:56:15 +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.

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.

Roadmap

  • Tags
  • Link relations
  • Extended YAML front matter support

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