Skip to content

Latest commit

 

History

History
106 lines (71 loc) · 4.54 KB

README.zh-CN.md

File metadata and controls

106 lines (71 loc) · 4.54 KB

Nólëbase 集成

English


多元化的文档工程工具合集

Nólëbase 是以 Nólëbase 为名,读作 nole-base,取自意为「知识」的昆雅语 nólë 和意为「基础」的英文 base,即「知识库」的开源知识库。

特点

  • 🚀 文档工程优先
    • 从文档工程的角度出发,解决和简化若干 UX/DX 的问题和困境,旨在让创作者更好地专注于撰写文档、笔记、制作卡片以及 GTD。
  • ⚖️ 兼容并且好用
    • 不论是静态如 VitePress,还是客户端优先如 Obsidian,「Nólëbase 集成」项目期望能够在不同的平台上提供近似甚至更好的体验。
  • 🧩 拓展工具的边界
    • 每个平台都有自己的优势和缺失的功能,但文档工程本来就耗时耗力。这些问题不应成为限制文档和知识编写与共享的障碍。使用「Nólëbase 集成」来扩展您的想象力吧。

快速开始

  • 文档: 在 README 中展示集成在 markdown-it 和 VitePress 中的效果和使用方法并不容易,为什么不试试使用我们使用 VitePress 生成的文档站点呢?
  • packages 目录: 所有的集成都被保存在 packages 目录下,每个集成都是一个独立的包。你可以在每个包目录下找到对应的 README 来获取更多的细节。

如果你只是想使用集成,你可以使用下面的命令将你需要的集成安装到你的 VitePress 项目中:

pnpm i @nolebase/<integration-name> -D

如果你也使用 @antfu/ni,也可以使用下面的命令来安装:

ni @nolebase/<integration-name> -D

要找到集成的名称,下面是一个我们当前支持的集成列表:

如何开发

  • 对于一般情况下的纯 TypeScript / JavaScript 库而言:我们使用 unbuildVite 来进行开发和构建。这意味着,在借助于 unbuild 底层所使用的 jiti 的强大功能的加持下,无需配置 Rollup,也无需使用 Vite,就能够监听本地文件的变化,并打包修改和开发的模块。
  • 对于需要加载非 RollupVite 兼容的插件的库而言(比如 Vue UI 库):我们依然会使用 Vite 来进行开发和构建,所以依然会涉及到本地文件的监听和打包。

我们可以直接运行下面的命令来监听和构建在 packages 目录下的所有项目打包后的文件:

pnpm run packages:stub

如果你也使用 @antfu/ni,也可以使用下面的命令来实现相同的效果:

nr packages:stub

接下来你需要启动项目的 VitePress 文档来进行预览和开发,你可以使用下面的命令:

pnpm run docs:dev

如果你也使用 @antfu/ni,也可以使用下面的命令来实现相同的效果:

nr docs:dev

如何构建

pnpm run packages:build

如果你也使用 @antfu/ni,也可以使用下面的命令来实现相同的效果:

nr packages:build

如果要构建文档和预览站点,你可以使用下面的命令:

pnpm run docs:build

如果你也使用 @antfu/ni,也可以使用下面的命令来实现相同的效果:

nr docs:build

用 ♥ 撰写