README.md

Nólëbase Integrations

简体中文

---

A collection of diverse documentation engineering tools.

Nólëbase is an open-source knowledge base named after Nólëbase, pronounced as nole-base, derived from the Quenya word 'nólë' meaning 'knowledge' and the English word 'base', hence 'knowledge base'.

Features

• 🌟 Easy to use
  • Easy and less caring about toolings. Writing is already time-consuming and labor-intensive. These issues should not be obstacles to restrict your creativity.
• 🗿 Cross-platform
  • Whether it is static-first like VitePress and Rspress, or client-first like Obsidian and Logseq, we hope to deliver the similar or even better experience across different platforms.
• 🔮 Rich Features
  • Expand your imagination far beyond with Nólëbase Integrations with loads of features, widgets, components to fill the gap between note-taking platforms while improving.
• 🚀 Writing First
  • From the perspective of documentation engineering, solve and simplify some UX/DX problems, aiming to let creators focus on writing documents, notes, making cards and GTD!

Sponsors

This project is made possible by all the sponsors supporting our work
You can join them at our sponsors profile:

Get started

• Documentation: It's not easy to demonstrate how integrations work with VitePress, and navigate to find references in README, why don't we give it a try to use our documentation site generated by VitePress?
• packages directory: All the integrations are kept under the packages directory, and each integration is a separate package. You can find the corresponding README in each package directory for more details.

If you just want to use the integrations, you can use the following command to install the integrations you need into your VitePress project:

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

If you use @antfu/ni, you can also use the following command:

ni @nolebase/<integration-name> -D

To find out the integration name, there is a list of integrations below.

• UnoCSS (for Obsidian)
• Auto Sidebar
• Bi-Directional Links (for markdown-it)
• Elements Transformation (for markdown-it)
• Lazy loading blurred thumbnails (for markdown-it)
• Enhanced Readabilities (for VitePress)
• Git-based page histories (for VitePress)
• Inline Link Previewing (for VitePress)
• Blinking highlight targeted heading (for VitePress)
• Page properties (for VitePress)
• Page <meta> metadata generation
• Previewing image (social media card) generation (for VitePress)
• Enhanced <mark> element (for VitePress)
• Thumbnail hashing for images (for VitePress)

Community

• Join our Discord server for discussions, support, and announcements!
• Join our Telegram group for discussions, support!

How to develop

The project uses unbuild and vite to develop and build. With the powerful features offered from jiti, we no longer need to use Rollup for tedious configuration and then watch the local file changes and bundle the modified and developed the modules without vite for hot-reload. We can directly run the following command to output the bundled file and get started on development:

# run these scripts in root folder
pnpm i
pnpm run packages:stub

If you use @antfu/ni, you can also use the following command:

nr packages:stub

Next, you need to start the the documentation site (with VitePress) for previewing and development. You can use the following command:

pnpm run docs:dev

If you use @antfu/ni, you can also use the following command:

nr docs:dev

How to build

pnpm run packages:build

If you use @antfu/ni, you can also use the following command:

nr packages:build

To build the documentation and preview site, you can use the following command:

pnpm run docs:build

If you use @antfu/ni, you can also use the following command:

nr docs:build

Star History

Project Status

Contributors

Thanks to all the contributors!

Written with ♥