Skip to content

Extensions and utilities regarding Obsidian Flavored Markdown and the Obsidian.md ecosystem.

License

Notifications You must be signed in to change notification settings

MoritzRS/obsidian-ext

Repository files navigation

obsidian-ext

Build GitHub License

Extensions and utilities regarding Obsidian Flavored Markdown (OFM) and the Obsidian.md ecosystem.

Feature Highlights

  • robust (tested, 100% coverage, fully typed)
  • small (minimal dependencies)
  • obsidian flavored markdown (Callouts, Tags, Wikilinks)
  • json canvas (validate, parse, transform)

When should I use this?

  • If you want to parse or transform Obsidian Flavored Markdown (OFM)
  • If you want to work with JSON Canvas
  • If you want to work with files from your Obsidian vault

What is this?

This repository started out as simple extensions to micromark, mdast and remark to support Obsidian Flavored Markdown (OFM). I started this project because I was not satisfied with the existing solutions for parsing and transforming OFM. Solutions like quartz did already support OFM, but I disliked their regex based approach. While working on it, I also realized problems in the way Obsidian itself parses markdown (especially whitespaces in wikilinks) which lead me to create my own set of extensions to micromark and mdast. After a short while I also wanted to work with the JSON Canvas format, so I added utilities for that as well.

Contents

Markdown

JSON Canvas

In Progress / Planned

  • Add more tests
  • Add mdast utility to resolve links
  • Add support for OFM Comments
  • Add support for OFM Blocks
  • Add support for mdast-util-to-hast
  • Add mdast utility to transform OFM to GFM (Github Flavored Markdown) and other formats
  • Add more utilities for jsoncanvas (e.g. to transform to other formats)
  • Add Codemirror language extensions
  • Add CLI (analyze/check/convert content)
  • Add web exporter

Contribute

I don't know if i can check PRs in a timely manner, but feel free to open PRs or issues. If participation is high I will need to add a code of conduct and contribution guidelines.

Disclaimer

This package is not affiliated with Obsidian.md or the developers of Obsidian.md

License

MIT © Moritz R. Schulz

About

Extensions and utilities regarding Obsidian Flavored Markdown and the Obsidian.md ecosystem.

Topics

Resources

License

Stars

Watchers

Forks