mirror of https://github.com/mickael-menu/zk synced 2024-11-07 15:20:21 +00:00

Go to file

Mickaël Menu 36365c68fb Expose environment variables to note templates with the new {{env}} variable		2021-03-11 21:18:29 +01:00
adapter	Save additional metadata in the database (#7 )	2021-03-08 21:38:32 +01:00
cmd	Add a [format.markdown] config section to customize tags syntax	2021-03-11 20:59:53 +01:00
core	Expose environment variables to note templates with the new {{env}} variable	2021-03-11 21:18:29 +01:00
docs	Expose environment variables to note templates with the new {{env}} variable	2021-03-11 21:18:29 +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	Expose environment variables to note templates with the new {{env}} variable	2021-03-11 21:18:29 +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	Save additional metadata in the database (#7 )	2021-03-08 21:38:32 +01:00
README.md	Filter notes by tags (#6 )	2021-03-07 17:00:09 +01:00

zk

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.

zk was only tested on macOS and Linux.

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