Archives/zk
2
0
Fork 0
mirror of https://github.com/mickael-menu/zk synced 2024-11-07 15:20:21 +00:00
Code Issues Projects Releases Wiki Activity
137 Commits 3 Branches 18 Tags 2.3 MiB
Go 99.4%
Makefile 0.6%
7c1bd8b318
Go to file
Mickaël Menu 7c1bd8b318
Improve README
2021-02-27 12:56:45 +01:00
adapter Override default sort orders with --sort 2021-02-27 11:23:16 +01:00
cmd Disable --not-link* variants and move database to .zk/notebook.db 2021-02-27 10:20:53 +01:00
core Override default sort orders with --sort 2021-02-27 11:23:16 +01:00
docs Improve README 2021-02-27 12:56:45 +01:00
util Make the fzf preview command customizable 2021-02-11 21:31:47 +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
go Override default sort orders with --sort 2021-02-27 11:23:16 +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 Improve README 2021-02-27 12:56:45 +01:00
run Override default sort orders with --sort 2021-02-27 11:23:16 +01:00

README.md

zk

A plain text note-taking assistant

Screenshot

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