hibi README

README проекта с github.com/schmayterling/hibi. Одним файлом markdown: README.md.

hibi

CodSpeed

join the support/developer discord | get the latest nightly | read the docs

hibi is a desktop editor for local notes and documents. write in markdown, latex, (language here you probably know), edit the source, or keep both views side by side and come build the open source app for everything you write.

CleanShot 2026-09-21 at 9 16 14 AM@2x

get started

download a build from releases and back up your notes before using a nightly build.

[!NOTE] window nightlies are currently ad-hoc signed. which means you may get a smartscreen warning, this is currently the case until we get into a stable build.

macos nightlies are signed properly and you won't get a gatekeeper warning (hopefully).

on linux, pick the AppImage, .deb, or .flatpak for your architecture (x64 or arm64). only the AppImage can update itself; install a newer .deb or .flatpak the same way to update:

sudo apt install ./hibi-<version>-linux-x64.deb
flatpak install --user ./hibi-<version>-linux-x64.flatpak

the flatpak needs flathub set up so it can download its runtime.

start typing, open a file, or open a folder as a workspace. confused? read the user guide.

roadmaps and discussions are available on the hibi discord.

found a bug? report here

obsidian compatibility

effort has been done to make hibi compatible with your obsidian vaults, however this is done on a best-effort basis. it is highly recommended that you back up your obsidian notes prior to using hibi.

updating hibi

use the built in updater once you've installed your nightly, for dev builds use git pull.

CleanShot 2026-09-26 at 3 01 36 AM@2x

build from source

Use Node 24 LTS (nvm use), or Node 22.18 or later or PNPM if you'd like:

npm ci
npm run dev

for build commands, tests, and addon development, see developer and agent notes.

docker

You can use the multi-stage Docker environment to develop or build Hibi without installing Node.js or PNPM on your host system.

development environment

Build the development image and run commands with your working directory mounted:

# build the dev container image
docker build --target dev -t hibi:dev .

# start an interactive shell
docker run --rm -it -v "$(pwd):/app" -w /app hibi:dev bash

# or run checks and the dev server
docker run --rm -v "$(pwd):/app" -w /app hibi:dev pnpm run typecheck
docker run --rm -it -v "$(pwd):/app" -w /app -p 5173:5173 hibi:dev pnpm run dev

export standalone application artifact

Build and export the unpacked Linux application binary directly to your host:

docker build --target artifact --output ./dist .

The compiled application files will be placed in ./dist, with the executable at ./dist/hibi.

minimal production image

Build a minimal Debian runtime image containing only the packaged application and required runtime libraries:

docker build --target runner -t hibi:latest .

contributing guidelines and ai policy

see this: CONTRIBUTING.md

license

hibi uses the GNU General Public License v3.0. third-party credits and license texts are available in Settings → Hibi → Open source licenses.

hibi (schmayterling/hibi)

Ищем в базе…

206 ·GitHub
Что это такое?Hibi — это настольный редактор для локальных заметок и документов. Он позволяет писать в Markdown, LaTeX и других языках разметки, редактировать исходный текст напрямую или держать рядом исходный код и отрисованный вид.
Как это запустить?Скачайте готовый релиз для вашей ОС со страницы Releases или соберите из исходников с Node 24 LTS (или Node 22.18+) и pnpm.
Нужен ли мне Node.js, чтобы этим пользоваться?Только если вы собираете из исходников: понадобится Node 24 LTS (nvm use) или Node 22.18+, а также PNPM, если вы предпочитаете его. Для готовых релизов ничего дополнительно не нужно.
Есть ли подводные камни при установке, о которых стоит знать?Сейчас доступны только ночные сборки, поэтому сначала сделайте резервную копию заметок. Ночные сборки для Windows подписаны без полноценного сертификата (ad-hoc), и до выхода стабильной версии SmartScreen будет показывать предупреждение.
Какие операционные системы поддерживаются?Hibi работает в Windows, macOS и Linux. Для Linux доступны пакеты AppImage, .deb и .flatpak для архитектур x64 и arm64.
Где хранятся мои данные?Hibi — это редактор локальных заметок и документов, поэтому ваши файлы остаются на вашем компьютере, а не в облаке.
Работает ли hibi с моим существующим хранилищем Obsidian?Да, приложили усилия для поддержки хранилищ Obsidian, но это работает по принципу «насколько получится», поэтому перед переходом обязательно сделайте резервную копию хранилища.
Какие языки разметки поддерживает hibi?Согласно списку форматов проекта, hibi работает с Markdown, LaTeX, AsciiDoc, BBCode, Creole, Djot, RDoc, Typst и HTML.
Как обновить hibi после установки?После установки ночной сборки используйте встроенный механизм обновления; для сборок для разработчиков загрузите последние изменения командой git pull.
Можно ли одновременно видеть исходный код и отрисованный предпросмотр?Да, можно редактировать исходный код напрямую или держать открытыми рядом окна с исходником и предпросмотром.
Автор
schmayterling
Размер
31.1 MB
Звёзды
206
Возраст
2 мес
Коммиты · 90 дней