@blueprint-chart/docs
Public documentation for Blueprint Chart — handbook, guide, BPC DSL spec, and lib API reference.
This package serves two consumers:
- The VitePress site at
docs.blueprintchart.com — pnpm dev / pnpm build.
- Programmatic access for tooling such as
@blueprint-chart/mcp:
import { listDocs, getDoc } from '@blueprint-chart/docs'
const handbookPages = listDocs('handbook')
const { entry, content } = getDoc('handbook', 'design-principles')
Each dist/manifest.json entry has { slug, group, title, blurb, mdPath }. Markdown content lives under src/ and is shipped in the published package.
Groups
handbook — dataviz pedagogy (design principles, color, typography, ...)guide — usage guides (scenes, palettes, data transforms, ...)charts — per-chart-type docs (bar, line, area, ...)reference/dsl — BPC DSL specificationreference/api — @blueprint-chart/lib API reference
License
MIT
关于 @blueprint-chart/docs 的常见问题
@blueprint-chart/docs 是什么？
Public documentation for Blueprint Chart — handbook, guide, BPC DSL spec, and lib API reference.
如何安装 @blueprint-chart/docs？
在项目目录运行 npm install @blueprint-chart/docs，或使用 pnpm add / yarn add / bun add。
@blueprint-chart/docs 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@blueprint-chart/docs 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@blueprint-chart/docs 可以商用吗？
@blueprint-chart/docs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@blueprint-chart/docs 的下载量有多少？
根据 npm 官方下载统计，@blueprint-chart/docs 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,562 次，日均约 85 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@blueprint-chart/docs 还在维护吗？
最新版本 2.15.0 发布于 2026/11/08（今天）；至今共发布 53 个版本，其中过去 12 个月发布了 53 个；首次发布于 2026/05/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。