@braindb/astro

[!WARNING] You need to add @braindb/core as direct dependency due to vitejs/vite#14289

This is an Astro integration for BrainDB.

Usage

Installation

Install the integration automatically using the Astro CLI:

pnpm add @braindb/core
pnpm astro add @braindb/astro

npm install @braindb/core
npx astro add @braindb/astro

yarn add @braindb/core
yarn astro add @braindb/astro

Or install it manually:

1. Install the required dependencies

pnpm add @braindb/astro @braindb/core

npm install @braindb/astro @braindb/core

yarn add @braindb/astro @braindb/core

2. Add the integration to your astro config

+import brainDbAstro from "@braindb/astro";

export default defineConfig({
  integrations: [
+    brainDbAstro(),
  ],
});

if you need BrainDB instance

import { brainDbAstro, getBrainDb } from "@braindb/astro";

const bdb = getBrainDb();

Wiki links

By default plugin adds @braindb/remark-wiki-link to support wiki links ([[]])

You can disable it, like this:

export default defineConfig({
  integrations: [
+    brainDbAstro({ remarkWikiLink: false }),
  ],
});

TODO

• [ ] add @braindb/remark-dataview when it will be stable