- Автор
- schmayterling
- Размер
- 31.1 MB
- Звёзды
- 206
- Обновлён
- КоммитNov 11Релизv0.3.0Nov 08
- Возраст
- 2 мес
- Коммиты · 90 дней
README проекта с github.com/schmayterling/hibi. Одним файлом markdown: README.md.
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.
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.
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.
use the built in updater once you've installed your nightly, for dev builds use git pull.
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.
You can use the multi-stage Docker environment to develop or build Hibi without installing Node.js or PNPM on your host system.
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
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.
Build a minimal Debian runtime image containing only the packaged application and required runtime libraries:
docker build --target runner -t hibi:latest .
see this: CONTRIBUTING.md
hibi uses the GNU General Public License v3.0. third-party credits and license texts are available in Settings → Hibi → Open source licenses.