gro

gatsby-remark-obsidian

Gatsby plugin to support Obsidian markdown syntax

Showing:

Popularity

Downloads/wk

42

GitHub Stars

9

Maintenance

Last Commit

2mos ago

Contributors

0

Package

Dependencies

9

License

GPL-3.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

gatsby-remark-obsidian

Version License Code Climate

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

Examples

Running the tests

npm test

License

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

Free Software, Hell Yeah!

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100