Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nolebase/integrations
✍️ A collection of diverse documentation engineering tools. Better reading experience, inline link preview, highlight targeted title, enhanced <mark> element, state-of-the-art SEO and <meta> generation, og image, thumbhash & blurhash images and more!
https://github.com/nolebase/integrations
documentation knowledge-base markdown-it-plugin markdown-it-plugins obsidian obsidian-plugin vite vite-plugin vitepress vitepress-plugin
Last synced: 2 days ago
JSON representation
✍️ A collection of diverse documentation engineering tools. Better reading experience, inline link preview, highlight targeted title, enhanced <mark> element, state-of-the-art SEO and <meta> generation, og image, thumbhash & blurhash images and more!
- Host: GitHub
- URL: https://github.com/nolebase/integrations
- Owner: nolebase
- License: mit
- Created: 2023-08-23T08:04:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-19T10:45:13.000Z (4 days ago)
- Last Synced: 2024-12-20T20:04:24.777Z (2 days ago)
- Topics: documentation, knowledge-base, markdown-it-plugin, markdown-it-plugins, obsidian, obsidian-plugin, vite, vite-plugin, vitepress, vitepress-plugin
- Language: TypeScript
- Homepage: https://nolebase-integrations.ayaka.io
- Size: 77.5 MB
- Stars: 162
- Watchers: 5
- Forks: 32
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [Nólëbase](https://github.com/nolebase/nolebase) Integrations
[简体中文](./README.zh-CN.md)
---
A collection of diverse documentation engineering tools.
> [Nólëbase](https://github.com/nolebase/nolebase) 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](https://nolebase-integrations.ayaka.io/): 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](./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:
```shell
pnpm i @nolebase/ -D
```
If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command:
```shell
ni @nolebase/ -D
```
To find out the integration name, there is a list of integrations below.
- [UnoCSS (for Obsidian)](https://github.com/nolebase/obsidian-plugin-unocss)
- [Auto Sidebar (for VitePress)](./packages/vitepress-plugin-sidebar/README.md)
- [Bi-Directional Links (for `markdown-it`)](./packages/markdown-it-bi-directional-links/README.md)
- [Breadcrumbs (for VitePress)](./packages/vitepress-plugin-breadcrumbs/README.md)
- [Elements Transformation (for `markdown-it`)](./packages/markdown-it-element-transform/README.md)
- [Lazy loading blurred thumbnails (for `markdown-it`)](./packages/markdown-it-unlazy-img/README.md)
- [Enhanced Readabilities (for VitePress)](./packages/vitepress-plugin-enhanced-readabilities/README.md)
- [Git-based page histories (for VitePress)](./packages/vitepress-plugin-git-changelog/README.md)
- [Index page (for VitePress)](./packages/vitepress-plugin-index/README.md)
- [Inline Link Previewing (for VitePress)](./packages/vitepress-plugin-inline-link-preview/README.md)
- [Blinking highlight targeted heading (for VitePress)](./packages/vitepress-plugin-highlight-targeted-heading/README.md)
- [Page properties (for VitePress)](./packages/vitepress-plugin-page-properties/README.md)
- [Page `` metadata generation](./packages/vitepress-plugin-meta/README.md)
- [Previewing image (social media card) generation (for VitePress)](./packages/vitepress-plugin-og-image/README.md)
- [Enhanced `` element (for VitePress)](./packages/vitepress-plugin-enhanced-mark/README.md)
- [Thumbnail hashing for images (for VitePress)](./packages/vitepress-plugin-thumbnail-hash/README.md)
## Community
- [Join our Discord server](https://discord.gg/XuNFDcDZGj) for discussions, support, and announcements!
- [Join our Telegram group](https://t.me/+6WKTUzWijf1kMzFl) for discussions, support!
## How to develop
The project uses [`unbuild`](https://github.com/unjs/unbuild) and [`vite`](https://github.com/vitejs/vite) to develop and build. With the powerful features offered from [`jiti`](https://github.com/unjs/jiti), we no longer need to use [Rollup](https://rollupjs.org/) for tedious configuration and then watch the local file changes and bundle the modified and developed the modules without [`vite`](https://github.com/vitejs/vite) for hot-reload. We can directly run the following command to output the bundled file and get started on development:
```shell
# run these scripts in root folder
pnpm i
pnpm run packages:stub
```
If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command:
```shell
nr packages:stub
```
Next, you need to start the the documentation site (with VitePress) for previewing and development. You can use the following command:
```shell
pnpm run docs:dev
```
If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command:
```shell
nr docs:dev
```
## How to build
```shell
pnpm run packages:build
```
If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command:
```shell
nr packages:build
```
To build the documentation and preview site, you can use the following command:
```shell
pnpm run docs:build
```
If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command:
```shell
nr docs:build
```
## Star History
[](https://star-history.com/#nolebase/integrations&Date)
## Project Status
## Contributors
Thanks to all the contributors!
[](https://github.com/nolebase/integrations/graphs/contributors)
### Written with ♥