@arborium/arborium

中文文档
2.18.2发布于 2026/08/28MIT OR Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 1.5万

High-performance syntax highlighting powered by tree-sitter and WebAssembly

原始使用文档
文档目录9 节
  1. Installation
  2. Usage
  3. Option 1: Drop-in Script (Easiest)
  4. Option 2: ESM Module (Programmatic)
  5. Themes
  6. Available Themes
  7. Theme Attribution
  8. Links
  9. License

@arborium/arborium

High-performance syntax highlighting powered by tree-sitter and WebAssembly.

npm License

Installation

npm install @arborium/arborium

Usage

Option 1: Drop-in Script (Easiest)

Add a single script tag and arborium auto-highlights all code blocks:

<script src="https://cdn.jsdelivr.net/npm/@arborium/arborium/dist/arborium.iife.js"></script>

That's it! Arborium will:

  • Auto-detect languages from class="language-*" or data-lang="*" attributes
  • Load grammar WASM plugins on-demand from jsDelivr CDN
  • Inject the default theme CSS

Configuration via data attributes:

<script
  src="https://cdn.jsdelivr.net/npm/@arborium/arborium/dist/arborium.iife.js"
  data-theme="tokyo-night"
  data-selector="pre code"
></script>

Option 2: ESM Module (Programmatic)

import { loadGrammar, highlight } from '@arborium/arborium';

// Load a grammar (fetched from CDN on first use)
const grammar = await loadGrammar('rust');

// Highlight code
const html = grammar.highlight('fn main() { println!("Hello!"); }');

// Or use the convenience function
const html = await highlight('rust', code);

Themes

This package includes 33 built-in themes. Import them individually:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@arborium/arborium/dist/themes/tokyo-night.css">

Or import in JavaScript:

import '@arborium/arborium/themes/tokyo-night.css';

Available Themes

Dark themes: catppuccin-mocha, catppuccin-macchiato, catppuccin-frappe, dracula, evergarden-fall, tokyo-night, nord, one-dark, github-dark, gruvbox-dark, monokai, kanagawa-dragon, rose-pine-moon, ayu-dark, solarized-dark, ef-melissa-dark, melange-dark, cobalt2, zenburn, desert256, rustdoc-dark, rustdoc-ayu

Light themes: catppuccin-latte, github-light, gruvbox-light, ayu-light, solarized-light, melange-light, light-owl, lucius-light, dayfox, alabaster, rustdoc-light

Theme Attribution

All themes are adaptations of color schemes from their original projects. We are grateful to the original theme authors:

ThemeSource
Ayuayu-theme/ayu-colors
Catppuccincatppuccin/catppuccin
Cobalt2wesbos/cobalt2-vscode
DayfoxEdenEast/nightfox.nvim
Desert256vim-scripts/desert256.vim
Draculadraculatheme.com
EF Melissaprotesilaos.com/emacs/ef-themes
GitHubprimer/github-vscode-theme
Gruvboxmorhetz/gruvbox
Kanagawarebelot/kanagawa.nvim
Light Owlsdras/night-owl-vscode-theme
Luciusjonathanfilip/vim-lucius
Melangesavq/melange-nvim
Monokaimonokai.pro
Nordnordtheme.com
One Darkatom/one-dark-syntax
Rosé Pinerosepinetheme.com
Rustdocrust-lang/rust
Solarizedethanschoonover.com/solarized
Tokyo Nightenkia/tokyo-night-vscode-theme
Zenburnjnurmine/Zenburn
Alabastertonsky/vscode-theme-alabaster

License

MIT OR Apache-2.0

The bundled themes are adaptations of color schemes from their respective projects. Please see each project's repository for their specific licensing terms.

版本与发布记录

@arborium/arborium 共发布 44 个版本,首次发布于 2025/12/05;过去 12 个月发布了 44 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.18.2latest2026/08/282 个月前
2.18.12026/06/234 个月前
2.18.02026/06/015 个月前
2.17.02026/05/095 个月前
2.16.02026/03/127 个月前
2.14.02026/03/028 个月前

关于 @arborium/arborium 的常见问题

@arborium/arborium 是什么?

High-performance syntax highlighting powered by tree-sitter and WebAssembly

如何安装 @arborium/arborium?

在项目目录运行 npm install @arborium/arborium,或使用 pnpm add / yarn add / bun add。

@arborium/arborium 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@arborium/arborium 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@arborium/arborium 可以商用吗?

@arborium/arborium 使用 MIT OR Apache-2.0 许可。可在 MIT、Apache-2.0 中任选其一遵守。选择 MIT 时,宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@arborium/arborium 的下载量有多少?

根据 npm 官方下载统计,@arborium/arborium 在 2026/10/07 – 2026/11/05 这 30 天内被下载 15,123 次,日均约 504 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@arborium/arborium 还在维护吗?

最新版本 2.18.2 发布于 2026/08/28(2 个月前);至今共发布 44 个版本,其中过去 12 个月发布了 44 个;首次发布于 2025/12/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。