mirror of
https://github.com/mickael-menu/zk
synced 2024-11-15 12:12:56 +00:00
add installation instructions to landing page of docs site (#459)
This commit is contained in:
Tillman Jex
GitHub
parent
a2bc5253e0
commit
1741d3baa6
2
Makefile
2
Makefile
@ -68,7 +68,7 @@ clean:
|
||||
### Sphinx Docs ###
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
docs: Makefile
|
||||
zkdocs: Makefile
|
||||
mkdir -p docs-build
|
||||
sphinx-build -a docs docs-build
|
||||
|
||||
|
||||
@ -26,5 +26,5 @@ exclude_patterns = [".zk"]
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme = "furo"
|
||||
html_static_path = ["_static"]
|
||||
# html_static_path = ["_static"]
|
||||
master_doc = "index"
|
||||
|
||||
@ -7,7 +7,64 @@
|
||||
|
||||
`zk` is a plain text note-taking tool that leverages the power of the command line.
|
||||
|
||||
Let's :doc:`get started <tips/getting-started>`.
|
||||
Install as below and then... :doc:`get zettling <tips/getting-started>`!
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
Homebrew:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
brew install zk
|
||||
|
||||
# Or, if you want to be on the bleeding edge:
|
||||
brew install --HEAD zk
|
||||
|
||||
|
||||
Nix:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
# Run zk from Nix store without installing it:
|
||||
nix run nixpkgs#zk
|
||||
|
||||
# Or, to install it permanently:
|
||||
nix-env -iA zk
|
||||
|
||||
Alpine Linux:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
# `zk` is currently available in the `testing` repositories:
|
||||
apk add zk
|
||||
|
||||
Arch Linux:
|
||||
|
||||
You can install [the zk package](https://archlinux.org/packages/extra/x86_64/zk/) from the official repos.
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
sudo pacman -S zk
|
||||
|
||||
Build from scratch:
|
||||
|
||||
Make sure you have a working [Go 1.21+ installation](https://golang.org/), then clone the repository:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
git clone https://github.com/zk-org/zk.git
|
||||
cd zk
|
||||
|
||||
On macOS / Linux:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
make
|
||||
./zk -h
|
||||
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
@ -1,197 +0,0 @@
|
||||
# zk configuration file
|
||||
#
|
||||
# Uncomment the properties you want to customize.
|
||||
|
||||
# NOTE SETTINGS
|
||||
#
|
||||
# Defines the default options used when generating new notes.
|
||||
[note]
|
||||
|
||||
# Language used when writing notes.
|
||||
# This is used to generate slugs or with date formats.
|
||||
#language = "en"
|
||||
|
||||
# The default title used for new note, if no `--title` flag is provided.
|
||||
#default-title = "Untitled"
|
||||
|
||||
# Template used to generate a note's filename, without extension.
|
||||
#filename = "{{id}}"
|
||||
|
||||
# The file extension used for the notes.
|
||||
#extension = "md"
|
||||
|
||||
# Template used to generate a note's content.
|
||||
# If not an absolute path or "~/unix/path", it's relative to .zk/templates/
|
||||
template = "default.md"
|
||||
|
||||
# Path globs ignored while indexing existing notes.
|
||||
#ignore = [
|
||||
# "drafts/*",
|
||||
# "log.md"
|
||||
#]
|
||||
|
||||
# Configure random ID generation.
|
||||
|
||||
# The charset used for random IDs. You can use:
|
||||
# * letters: only letters from a to z.
|
||||
# * numbers: 0 to 9
|
||||
# * alphanum: letters + numbers
|
||||
# * hex: hexadecimal, from a to f and 0 to 9
|
||||
# * custom string: will use any character from the provided value
|
||||
#id-charset = "alphanum"
|
||||
|
||||
# Length of the generated IDs.
|
||||
#id-length = 4
|
||||
|
||||
# Letter case for the random IDs, among lower, upper or mixed.
|
||||
#id-case = "lower"
|
||||
|
||||
|
||||
# EXTRA VARIABLES
|
||||
#
|
||||
# A dictionary of variables you can use for any custom values when generating
|
||||
# new notes. They are accessible in templates with {{extra.<key>}}
|
||||
[extra]
|
||||
|
||||
#key = "value"
|
||||
|
||||
|
||||
# GROUP OVERRIDES
|
||||
#
|
||||
# You can override global settings from [note] and [extra] for a particular
|
||||
# group of notes by declaring a [group."<name>"] section.
|
||||
#
|
||||
# Specify the list of directories which will automatically belong to the group
|
||||
# with the optional `paths` property.
|
||||
#
|
||||
# Omitting `paths` is equivalent to providing a single path equal to the name of
|
||||
# the group. This can be useful to quickly declare a group by the name of the
|
||||
# directory it applies to.
|
||||
|
||||
#[group."<NAME>"]
|
||||
#paths = ["<DIR1>", "<DIR2>"]
|
||||
#[group."<NAME>".note]
|
||||
#filename = "{{format-date now}}"
|
||||
#[group."<NAME>".extra]
|
||||
#key = "value"
|
||||
|
||||
|
||||
# MARKDOWN SETTINGS
|
||||
[format.markdown]
|
||||
|
||||
# Format used to generate links between notes.
|
||||
# Either "wiki", "markdown" or a custom template. Default is "markdown".
|
||||
#link-format = "wiki"
|
||||
# Indicates whether a link's path will be percent-encoded.
|
||||
# Defaults to true for "markdown" format and false for "wiki" format.
|
||||
#link-encode-path = true
|
||||
# Indicates whether a link's path file extension will be removed.
|
||||
# Defaults to true.
|
||||
#link-drop-extension = true
|
||||
|
||||
# Enable support for #hashtags.
|
||||
hashtags = false
|
||||
# Enable support for :colon:separated:tags:.
|
||||
colon-tags = false
|
||||
# Enable support for Bear's #multi-word tags#
|
||||
# Hashtags must be enabled for multi-word tags to work.
|
||||
multiword-tags = false
|
||||
|
||||
|
||||
# EXTERNAL TOOLS
|
||||
[tool]
|
||||
|
||||
# Default editor used to open notes. When not set, the EDITOR or VISUAL
|
||||
# environment variables are used.
|
||||
#editor = "vim"
|
||||
|
||||
# Pager used to scroll through long output. If you want to disable paging
|
||||
# altogether, set it to an empty string "".
|
||||
#pager = "less -FIRX"
|
||||
|
||||
# Command used to preview a note during interactive fzf mode.
|
||||
# Set it to an empty string "" to disable preview.
|
||||
|
||||
# bat is a great tool to render Markdown document with syntax highlighting.
|
||||
#https://github.com/sharkdp/bat
|
||||
#fzf-preview = "bat -p --color always {-1}"
|
||||
|
||||
|
||||
# LSP
|
||||
#
|
||||
# Configure basic editor integration for LSP-compatible editors.
|
||||
# See https://github.com/zk-org/zk/blob/main/docs/editors-integration.md
|
||||
#
|
||||
[lsp]
|
||||
|
||||
[lsp.diagnostics]
|
||||
# Each diagnostic can have for value: none, hint, info, warning, error
|
||||
|
||||
# Report titles of wiki-links as hints.
|
||||
#wiki-title = "hint"
|
||||
# Warn for dead links between notes.
|
||||
dead-link = "error"
|
||||
|
||||
[lsp.completion]
|
||||
# Customize the completion pop-up of your LSP client.
|
||||
|
||||
# Show the note title in the completion pop-up, or fallback on its path if empty.
|
||||
#note-label = "{{title-or-path}}"
|
||||
# Filter out the completion pop-up using the note title or its path.
|
||||
#note-filter-text = "{{title}} {{path}}"
|
||||
# Show the note filename without extension as detail.
|
||||
#note-detail = "{{filename-stem}}"
|
||||
|
||||
|
||||
# NAMED FILTERS
|
||||
#
|
||||
# A named filter is a set of note filtering options used frequently together.
|
||||
#
|
||||
[filter]
|
||||
|
||||
# Matches the notes created the last two weeks. For example:
|
||||
# $ zk list recents --limit 15
|
||||
# $ zk edit recents --interactive
|
||||
#recents = "--sort created- --created-after 'last two weeks'"
|
||||
|
||||
|
||||
# COMMAND ALIASES
|
||||
#
|
||||
# Aliases are user commands called with `zk <alias> [<flags>] [<args>]`.
|
||||
#
|
||||
# The alias will be executed with `$SHELL -c`, please refer to your shell's
|
||||
# man page to see the available syntax. In most shells:
|
||||
# * $@ can be used to expand all the provided flags and arguments
|
||||
# * you can pipe commands together with the usual | character
|
||||
#
|
||||
[alias]
|
||||
# Here are a few aliases to get you started.
|
||||
|
||||
# Shortcut to a command.
|
||||
#ls = "zk list $@"
|
||||
|
||||
# Default flags for an existing command.
|
||||
#list = "zk list --quiet $@"
|
||||
|
||||
# Edit the last modified note.
|
||||
last = "zk edit --limit 1 --sort modified- $@"
|
||||
|
||||
# Edit the notes selected interactively among the notes created the last two weeks.
|
||||
# This alias doesn't take any argument, so we don't use $@.
|
||||
#recent = "zk edit --sort created- --created-after 'last two weeks' --interactive"
|
||||
|
||||
# Print paths separated with colons for the notes found with the given
|
||||
# arguments. This can be useful to expand a complex search query into a flag
|
||||
# taking only paths. For example:
|
||||
# zk list --link-to "`zk path -m potatoe`"
|
||||
#path = "zk list --quiet --format {{path}} --delimiter , $@"
|
||||
|
||||
# Show a random note.
|
||||
#lucky = "zk list --quiet --format full --sort random --limit 1"
|
||||
|
||||
# Returns the Git history for the notes found with the given arguments.
|
||||
# Note the use of a pipe and the location of $@.
|
||||
#hist = "zk list --format path --delimiter0 --quiet $@ | xargs -t -0 git log --patch --"
|
||||
|
||||
# Edit this configuration file.
|
||||
#conf = '$EDITOR "$ZK_NOTEBOOK_DIR/.zk/config.toml"'
|
||||
@ -1,3 +0,0 @@
|
||||
# {{title}}
|
||||
|
||||
{{content}}
|
||||
Loading…
Reference in New Issue
Block a user