Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Obsidian Flavored Markdown reader/writer #9883

Open
kepano opened this issue Jun 15, 2024 · 2 comments
Open

Obsidian Flavored Markdown reader/writer #9883

kepano opened this issue Jun 15, 2024 · 2 comments

Comments

@kepano
Copy link

kepano commented Jun 15, 2024

Describe your proposed improvement and the problem it solves.

Add a reader and writer for Obsidian Flavored Markdown. Obsidian Flavored Markdown combines features from CommonMark, GitHub Flavored Markdown and LaTeX, as well as several extensions inspired by wiki markup.

Syntax Description
[[Link]] Internal links
![[Link]] Embed files
![[Link#^id]] Block references
^id Defining a block
%%Text%% Comments
~~Text~~ Strikethroughs
==Text== Highlights
``` Code blocks
- [ ] Incomplete task
- [x] Completed task
> [!note] Callouts
(GFM syntax) Tables

Describe alternatives you've considered.

Most of these extensions exist in one form or another within Pandoc, but it seems like it would be convenient to bundle them all together in a way that makes converting to/from Obsidian files easier. I'd like to explore implementing this myself, but wanted to first gauge interest.

@jgm
Copy link
Owner

jgm commented Jun 18, 2024

I think we already have all the needed extensions, except for [^id] for defining a block (and similarly "block references") and comments.
So, if these things were implemented, one could easily package obsidian flavored markdown as a set of extensions on top of commonmark.

@jgm
Copy link
Owner

jgm commented Jun 18, 2024

Note that to make these extensions on top of commonmark, one would have to add modules to commonmark-extensions. This parsing work would not be done in pandoc itself, though support for the new features in the writer would have to be done in pandoc's markdown writer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants