gatsby-remark-obsidian

Gatsby plugin to support Obsidian markdown syntax.

NOTE: I also created a non-gatsby plugin (remark-obsidian) if you want 🙂.

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
                    },
                },
            ]
        }
    },
],

Examples

• Example with remark
• Example with mdx

Running the tests

npm test

Support me

I'd love to work on this project, but my time on this earth is limited, support my work to give me more time!

Please support me with a one-time or a monthly donation and help me continue my activities.

License

This project is licensed under the GNU GPL v3.0 - see the LICENSE file for details

Free Software, Hell Yeah!