README.zh-CN.md

Nólëbase 集成

English

---

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

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

特点

• 🌟 简单易用
  • 简单易用，让作者少些操心，更何况写作本就耗时耗力，这些问题不应该成为限制您创造力的障碍。
• 🗿 跨平台
  • 不论是静态如 VitePress，Rspress，还是客户端优先如 Obsidian 和 Logseq，我们期望能够在不同的平台上为您提供近似甚至更好的体验。
• 🔮 丰富的功能
  • 通过「Nólëbase 集成」所提供的大量的功能、小部件、组件，填补笔记平台和工具之间的差距并优化整体体验。
• 🚀 写作优先
  • 从文档工程的角度出发，解决和简化若干 UX/DX 的问题和困境，旨在让创作者更好地专注于撰写文档、笔记、制作卡片以及 GTD。

Sponsors

这个项目得以实现，要感谢所有支持我们的 Sponsors
你也可以访问我们的 Sponsors 页面来加入其中：

快速开始

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

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

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

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

ni @nolebase/<integration-name> -D

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

• UnoCSS (Obsidian 插件)
• 自动生成侧边栏（VitePress 插件）
• 双向链接（markdown-it 插件）
• 面包屑导航（VitePress 插件）
• 元素转换（markdown-it 插件）
• 懒加载模糊预览图（markdown-it 插件）
• 阅读增强（VitePress 插件）
• 基于 Git 的页面历史（VitePress 插件）
• 索引页（VitePress 插件）
• 行内链接预览（VitePress 插件）
• 闪烁高亮当前的目标标题（VitePress 插件）
• 页面属性（VitePress 插件）
• 预览图片（社交媒体卡片）生成（VitePress 插件）
• 页面 <meta> 元信息生成
• <mark> 元素增强（VitePress 插件）
• 缩略图模糊哈希生成（VitePress 插件）

如何开发

• 对于一般情况下的纯 TypeScript / JavaScript 库而言：我们使用 unbuild 和 Vite 来进行开发和构建。这意味着，在借助于 unbuild 底层所使用的 jiti 的强大功能的加持下，无需配置 Rollup，也无需使用 Vite，就能够监听本地文件的变化，并打包修改和开发的模块。
• 对于需要加载非 Rollup 和 Vite 兼容的插件的库而言（比如 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

用 ♥ 撰写