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

Go to file

Mickaël Menu 52434f8618 Add the --mentioned-by filtering option (#15 ) Find every note whose title is mentioned in the note you are working on with `--mentioned-by file.md`		2021-03-20 19:17:46 +01:00
adapter	Add the --mentioned-by filtering option (#15 )	2021-03-20 19:17:46 +01:00
cmd	Add the --mentioned-by filtering option (#15 )	2021-03-20 19:17:46 +01:00
core	Add the --mentioned-by filtering option (#15 )	2021-03-20 19:17:46 +01:00
docs	Add the --mentioned-by filtering option (#15 )	2021-03-20 19:17:46 +01:00
util	Add support for nested maps in the YAML frontmatter	2021-03-19 21:19:55 +01:00
.gitattributes	Improve README	2021-02-27 12:56:45 +01:00
.gitignore	Fix --version output	2021-03-18 19:39:06 +01:00
CHANGELOG.md	Add the --mentioned-by filtering option (#15 )	2021-03-20 19:17:46 +01:00
go	Fix --version output	2021-03-18 19:39:06 +01:00
go.mod	Add support for nested maps in the YAML frontmatter	2021-03-19 21:19:55 +01:00
go.sum	Add support for nested maps in the YAML frontmatter	2021-03-19 21:19:55 +01:00
LICENSE	Initial commit	2020-12-23 16:07:53 +01:00
main.go	Fix missing import	2021-03-18 20:27:08 +01:00
README.md	Fix --version output	2021-03-18 19:39:06 +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.

Creating notes from templates
Advanced search and filtering capabilities including tags, links and mentions
Interactive browser, powered by fzf
Git-style command aliases
Made with automation in mind
Notebook housekeeping
Future-proof, thanks to Markdown
Supports most Markdown syntax flavors
- Links: regular Markdown links, [[Wikilinks]] and Neuron's [[Folgezettel links]]#.
- Tags: #hashtags, :colon:separated:tags:, Bear's #multi-word tags#.
- YAML frontmatter

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

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

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