zk

Помощник по созданию текстовых заметок

Описание

zk — это инструмент командной строки, помогающий вам поддерживать обычный текстовый Зеттелькастен или личную вики.

Ищете быстрый пример использования?

Или хотите увидеть это в действии? Посмотрите видео Шивана «Система ведения заметок, которую должны учитывать ВСЕ программисты» .

Основные моменты

Примечание. Ссылки в списке ниже являются исходящими ↗.

• Создание заметок из шаблонов
• Расширенные возможности поиска и фильтрации, включая теги, ссылки и упоминания.
• Интеграция с вашими любимыми редакторами:
  • Любой LSP-совместимый редактор.
  • zk-nvim для Neovim 0.8+
  • zk-vscode для кода Visual Studio
• Интерактивный браузер на базе fzf
• Псевдонимы команд в стиле Git и именованные фильтры
• Сделано с учетом автоматизации
• Уход за ноутбуком
• Готовность к будущему благодаря Markdown
• Поддерживает большинство разновидностей синтаксиса Markdown.
  • Ссылки: обычные ссылки Markdown, [[Wikilinks]] и [[Folgezettel links]]# от Neuron.
  • Теги: #hashtags , :colon:separated:tags: , Bear's #multi-word tags# .
  • YAML-текст

Список будущих функций, ожидающих выхода, смотрите в журнале изменений.

Чем zk не является

• Редактор заметок.
• Инструмент для размещения ваших заметок в Интернете — для этого вас могут заинтересовать Neuron или Gollum.

Установить

Ознакомьтесь с последней версией готовых двоичных файлов для macOS и Linux ( zk не тестировался в Windows).

Домашнее пиво

brew install zk

Или, если вы хотите узнать о последних изменениях:

brew install --HEAD zk

Никс

 # Run zk from Nix store without installing it:
nix run nixpkgs#zk
# Or, to install it permanently:
nix-env -iA zk

Альпийский Линукс

zk в настоящее время доступен в testing репозиториях:

apk add zk

Арч Линукс

Вы можете установить пакет zk из официального репозитория.

sudo pacman -S zk

Построить с нуля

Убедитесь, что у вас установлена ​​рабочая версия Go 1.21+, а затем клонируйте репозиторий:

$ git clone https://github.com/zk-org/zk.git
$ cd zk

На MacOS/Linux

 $ make
$ ./zk -h

Содействие

Мы горячо приветствуем вопросы, пиар и дискуссии.

Здесь вы можете прочитать полезную информацию для участия в zk .

Связанные проекты

• Neuron – отличный инструмент для публикации Зеттелькастена в сети
• Emanote – улучшенный преемник Neuron
• зк сиропсена — сборник скриптов аналогичного назначения
• zk-spaced – плагин интервального повторения для zk