1.0.2 • Published 11 months ago

remark-docusaurus-obsidian-bridge v1.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
11 months ago

remark-obsidian-to-docusaurus

A Remark plugin to transform Obsidian-specific Markdown syntax into Docusaurus-compatible syntax

ObsidianDocusaurus (Without plugin)Docusaurus (With plugin)
obsidian_demodocusaurus_without_plugin_demodocusaurus_with_plugin_demo

Handles

🌳 Usage

  1. Run npm install remark-docusaurus-obsidian-bridge

  2. Add the following to your docusaurus.config.js or docusaurus.config.ts

{
    ...
    presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
          exclude: ["**/templates/*"],
          beforeDefaultRemarkPlugins: [
            [convertToDocusaurusMdx, { customReplacers: [dateTagReplacer] }],
          ],
        },
        ...
      } satisfies Preset.Options,
    ],
  ],
  ...
}

📚 Resources

📄 License

MIT © Chan Jun Ren