Gatsby-remark-obsidian NPM

gatsby-remark-obsidian

Gatsby plugin to support Obsidian markdown syntax.

Requirements

Nodejs >= 14

Features

Support ==highlight text==
Support [[Internal link]]
Support [[Internal link|With custom text]]
Support [[Internal link#heading]]
Support [[Internal link#heading|With custom text]]
Support ![[Embed note]]
Support ![[Embed note#heading]]

Installation

npm install gatsby-remark-obsidian

Usage

Add the plugin to your Gatsby config:

// gatsby-config.js
plugins: [
    {
        resolve: "gatsby-transformer-remark",
        options: {
            plugins: [
                {
                    resolve: 'gatsby-remark-obsidian',
                    options: {
                        titleToURL: (title) => `/${title}`, // optional
                        markdownFolder: `${__dirname}/content`, // optional
                        highlightClassName: 'highlight', // optional
                    },
                },
            ]
        }
    },
],