Skip to content

Commit

Permalink
add installation instructions to landing page of docs site (#459)
Browse files Browse the repository at this point in the history
  • Loading branch information
tjex committed Sep 17, 2024
1 parent a2bc525 commit 1741d3b
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 203 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@
# 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"
59 changes: 58 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
197 changes: 0 additions & 197 deletions docs/source/.zk/config.toml

This file was deleted.

3 changes: 0 additions & 3 deletions docs/source/.zk/templates/default.md

This file was deleted.

0 comments on commit 1741d3b

Please sign in to comment.