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)

正在搜索数据库…

205 ·GitHub
这是什么?Hibi 是一款桌面端编辑器,用于编辑本地笔记和文档。你可以用 Markdown、LaTeX 以及其他多种标记语言编写内容,直接编辑源代码,或者让源代码和渲染后的预览并排显示。
我要怎样才能让它运行起来?从 Releases 页面下载适合你操作系统的预构建版本,或者使用 Node 24 LTS(或 Node 22.18 及以上版本)和 pnpm 从源代码构建。
使用它需要安装 Node.js 吗?只有从源代码构建时才需要:你需要 Node 24 LTS(执行 nvm use)或 Node 22.18 及以上版本,如果你习惯,也可以使用 PNPM。预构建版本则不需要任何额外安装。
安装时有什么需要注意的地方吗?目前只提供每夜构建版本(nightly),所以请先备份你的笔记。Windows 的每夜构建版本使用的是临时签名(ad-hoc),在正式版发布之前,运行时会触发 SmartScreen 警告。
支持哪些操作系统?Hibi 可在 Windows、macOS 和 Linux 上运行。Linux 版本提供 AppImage、.deb 或 .flatpak 格式,支持 x64 或 arm64 架构。
我的数据存放在哪里?Hibi 是一款本地笔记和文档编辑器,因此你的文件保存在自己的电脑上,而不是云端。
hibi 能和我现有的 Obsidian vault 一起使用吗?可以。我们已尽力支持 Obsidian vault,但这只是尽力而为的兼容,因此在切换之前,请先备份你的 vault。
hibi 支持哪些标记语言格式?根据项目列出的格式,hibi 支持 Markdown、LaTeX、AsciiDoc、BBCode、Creole、Djot、RDoc、Typst 和 HTML。
安装后我该如何更新 hibi?安装每夜构建版本后,使用内置的更新程序即可;如果是开发版本,则使用 git pull 拉取最新更改。
我能同时查看原始源代码和渲染预览吗?可以。你可以直接编辑源代码,也可以让源代码和预览视图并排打开。
大小
31.1 MB
星标
205
时长
2个月
提交 · 90 天