Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix links on landing page of docs site #460

Merged
merged 9 commits into from
Sep 17, 2024
Merged

fix links on landing page of docs site #460

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a87af2d
add demo video to readme
tjex Jul 23, 2024
f7867a6
cleanup readme from previous commit
tjex Jul 23, 2024
0d8c126
Merge branch 'main' of github.com:zk-org/zk into docs
tjex Aug 28, 2024
f0a193b
Merge branch 'main' into docs
tjex Sep 17, 2024
9c804d5
rm left over source folder, and update Makefile cmd for docs
tjex Sep 17, 2024
18cbdd3
update landing page to include install steps
tjex Sep 17, 2024
d058dfb
fix external links on landing page
tjex Sep 17, 2024
ed87e40
Merge branch 'main' into docs
tjex Sep 17, 2024
cf5d182
merge main
tjex Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@
.. image:: assets/media/screencast.svg
:align: center

.. toctree::
:hidden:
:titlesonly:

GitHub <https://github.com/zk-org/zk>
Neovim Plugin <https://github.com/zk-org/zk-nvim>

config/index
notes/index
tips/index

`zk` is a plain text note-taking tool that leverages the power of the command line.

Install as below and then... :doc:`get zettling <tips/getting-started>`!
Expand Down Expand Up @@ -41,15 +52,15 @@ Alpine Linux:

Arch Linux:

You can install [the zk package](https://archlinux.org/packages/extra/x86_64/zk/) from the official repos.
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:
Make sure you have a working `Go 1.21+ installation <https://golang.org/>`_, then clone the repository:

.. code-block:: sh

Expand All @@ -65,16 +76,3 @@ On macOS / Linux:




.. toctree::
:hidden:
:titlesonly:

GitHub <https://github.com/zk-org/zk>
Neovim Plugin <https://github.com/zk-org/zk-nvim>

config/index
notes/index
tips/index