Native Shell
Native Shell:AI 生成的 UI,在你的应用中原生呈现,覆盖每个平台。iOS、Android、macOS、Windows 与 Linux 上的应用、GPUI 应用与网页在运行时加载已签名、沙箱隔离的 TSX 模块并绘制 th
AI 翻译
A markdown-first documentation framework. Write with common mark and directives, compile to flat static HTML.
翻译准备中
取自仓库 README
正在加载完整 README。
查看完整 README ↗An open-source alternative to Mintlify or GitBook. Write documentation in markdown and directives. The toolchain runs on Bun, Node.js, or Deno — output is flat static HTML, no server required.
flowchart TD
Author["📝 Author<br/>writes markdown (.md)"] --> Flame["DocuBook Flame 🔥<br/>compiles to flat .html"]
Flame --> Host["📦 Static host"]
Host -->|serves static HTML| Browser["🌐 Browser"]
Browser -->|requests page| Host
[!WARNING] Verify the runtime is installed:
bun --version,node --version, ordeno --version.
Create the project directory, then run the flow for your runtime:
mkdir my-docs && cd my-docs
bun add @docubook/flame
bunx flame init
bun run dev
npm install @docubook/flame
npx flame init
npm run dev
deno run -A npm:@docubook/flame init
deno task dev
[!NOTE] We are very open to all your contributions, no matter how small your contribution is, it will certainly be part of the development of this project.
Please read: CONTRIBUTING.md
[!IMPORTANT] This repository uses a monorepo setup powered by pnpm workspaces and Turborepo to manage apps and packages in a single workspace.
For development workflow:
- Vitest provides fast unit testing with native ESM and TypeScript support
- Changesets handles package versioning and release management
- Husky runs automatic linting and formatting before commits
- commitlint ensures commit messages follow the Conventional Commits format consistently
This setup helps keep the codebase organized, maintainable, and contributor-friendly.