Obsidian Stats logoObsidian Stats

Pandoc Extended Markdown

by errortzy
5
4
3
2
1
Score: 48/100
Install Code

Description

This plugin enables Obsidian to render Pandoc extended markdown lists, and adds useful sidebar for lists and footnotes

Reviews

No reviews yet.

Stats

39
stars
6,805
downloads
0
forks
145
days
97
days
97
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
17
total issues
5
open issues
12
closed issues
239
commits

Latest Version

1.8.8
3 months ago

Changelog

  • fixed folded heading performance in Live Preview
See all version on GitHub

README file from

Github

Pandoc Extended Markdown

Pandoc Extended Markdown is an Obsidian plugin that makes common Pandoc Markdown extensions readable in Live Preview and Reading mode while preserving the original Markdown source.

It focuses on syntax that is useful while writing notes: fancy lists, definition lists, example lists, fenced divs, custom label lists, superscripts, subscripts, list editing helpers, and an optional sidebar panel for navigating structured list-like content.

Highlights

Feature Example What it does
Superscript and subscript 2^10^, H~2~O Renders Pandoc-style inline super/subscripts.
Fancy lists A., a), iv., #. Renders alphabetic, Roman numeral, and hash auto-numbered lists.
Unordered list markers -, +, * Keeps - as the default round marker, renders + as a square, and renders * as a hollow round marker.
Definition lists Term followed by : definition Renders Pandoc definition lists in Live Preview and Reading mode.
Example lists (@label) Example and (@label) Numbers examples and resolves local example references.
Fenced divs ::: {.theorem #thm title="Theorem &"} Renders Pandoc fenced divs with optional titles, numbering, local @id references, and rail-drag block moves in Live Preview.
Custom label lists {::P} Premise Adds custom labels, references, and placeholder numbering.
List editing helpers Enter, Tab, Shift+Tab Continues lists, cycles ordered marker styles by context, and can renumber affected list items.
List panel Command: Open list panel Shows expandable custom labels, examples, definition lists, fenced divs, and footnotes from the active note. Long labels wrap above their content.

In Reading mode, extended list items retain rendered images, links, formatting, code, and math. Parenthesized markers such as a) follow the list's numbering style and starting value.

Quick Start

Paste this into a note and switch to Live Preview.

Water is H~2~O, and 2^10^ is 1024.

A.  First point
B.  Second point
    a. Third point
    b. Fourth point

#. Auto-numbering list
#. Auto-numbering list

- Default round unordered marker
	+ Square unordered marker
		* Hollow round unordered marker

Term
:   A definition list item.

(@) This is a numbered example.
(@intro) This is a citable numbered example

{::P} A custom-labeled premise.
{::Q(#step)} A custom label with placeholder numbering.

See example (@intro), premise {::P}, and step {::Q(#step)}.

::: {.theorem #compact title="Theorem &"}
Every compact metric space is complete.
:::

::: theorem &.& #thm2
This is a sub theorem, using shortcut syntax
:::

See @compact and @thm2

Preview:

Rendering preview

Documentation

Start here if you want more than the quick start:

Modes And Settings

  • Live Preview is the main editing surface.
  • Reading mode renders the implemented syntax after Obsidian has produced its HTML.
  • Source mode preserves plain Markdown.
  • Pandoc list lenient spacing maps to Pandoc's lists_without_preceding_blankline extension: enable it to let a list interrupt paragraph text without a blank line; disable it to keep those markers in the paragraph. The rule applies within containers such as block quotes, footnotes, and fenced divs too. It does not impose a blank line after a list; a list following a heading can still contain nested lists with either setting.
  • Readable fenced div shorthand can be disabled separately when you want source closer to native Pandoc Markdown.

The plugin settings let you enable or disable individual syntax families, list marker cycling, auto-renumbering, distinct unordered-list marker rendering, and the sidebar list panel.

Pandoc Export

Pandoc export is an optional desktop-only module. It is disabled by default, is not loaded as a hard requirement for normal rendering, and is not available on mobile. Live Preview and Reading mode continue to work when Pandoc is missing, disabled, or unavailable.

Enable Pandoc export in plugin settings, optionally set a Pandoc executable path, then run Export with pandoc or Export with previous pandoc settings. Built-in profiles cover common Pandoc formats such as Markdown, HTML, PDF, DOCX, ODT, RTF, EPUB, LaTeX, Typst, PPTX, and bibliography export. The export preview selector covers Pandoc's output format list: browser-renderable formats use HTML/text previews, and PDF, DOCX, EPUB, ODT, and PPTX use bundled JavaScript renderers or the ODT fallback path.

Obsidian rendering does not automatically change Pandoc CLI output. The plugin bundles Lua filters for plugin-specific export behavior and writes them into the installed plugin folder on startup:

pandoc input.md --lua-filter=lua_filter/FencedDivExtendedSyntax.lua -o output.docx
pandoc input.md --preserve-tabs -f lua_filter/CustomLabelReader.lua \
    --lua-filter=lua_filter/CustomLabelList.lua -o output.docx

Custom label definitions require whitespace after the marker, as in {::P(#step)} Body. For direct CLI use, keep CustomLabelSupport.lua beside the custom-label reader and filter. The plugin deploys all three files automatically. The filter numbers definitions throughout nested containers and resolves known references, including forward references. Paragraph continuation lines retain their content and formatting; unknown references remain literal. Markdown export and preview profiles automatically apply both bundled syntax filters, the custom-label reader, and --preserve-tabs. This includes saved and new profiles with no configured Lua filters; no setup is needed. This preserves distinct whitespace in names, escaped markers, and marker-only lines with following whitespace. Verified with Pandoc 3.10.2; other versions may be compatible but have not been tested.

See Pandoc export and Pandoc variables and Lua filters for details.

Development

npm install
npm run dev
npm run build
npm run lint
npm test

See Development and tests/README.md for repository layout and test guidance.

Requirements

  • Obsidian 1.4.0 or newer.
  • Desktop and mobile are supported.

Support

Report bugs and feature requests in GitHub Issues.

License

MIT. See LICENSE.

Author

Created by Scott Tang.

Sponsors