Pandoc Crossref Preview shows figure and equation references while you read

Preview figure and equation numbers in a note.

MIT · no telemetry · core features free

A research note shows Figure 1 and Figure 2 references above two labelled images.
Open larger
version
1.1.0
released
downloads
26
review
Passed
health
Excellent
license
MIT
listed for
Desktop, Mobile
obsidian
1.13.4 or later

The directory takes these platforms from the plugin manifest. The automated tests run in the desktop app only.

Directory facts fetched from community.obsidian.md/users/theluckystrike.

About Pandoc Crossref Preview

Writers who use Pandoc labels in research notes and want to inspect references before exporting a draft.

Write simple figure and equation labels, then open Reading view. Pandoc Crossref Preview replaces resolved references with numbered links to their source lines.

The preview uses a limited grammar within one note. It doesn't run Pandoc or compare the preview with your export.

A research note with figure and equation references, followed by its label reportPlay demo

Free features

Figure references

Put a Markdown image on its own line with a label such as {#fig:sample}. Refer to it with @fig:sample and leave blank lines around the image paragraph.

Separate equation numbers

Put {#eq:decay} on the line after a simple display equation closes, then refer to it with @eq:decay. Equation numbers use a separate counter.

Two equations have separate numbered references beside a numbered figure.
Open larger

References before targets

References can appear before their targets in the same note. Select a resolved number to open its target source line. Reopen Reading view after adding or moving labelled objects.

The opening paragraph resolves references to a figure and equation defined below it.
Open larger

Label review

Run Show label report for indexed numbers, source lines and diagnostics. Missing or duplicated targets keep their literal reference text.

The label report lists duplicate, missing and unsupported labels in the sample note.
Open larger

Literal code and links

Inline code, fenced code, URL text and existing rendered links keep literal reference syntax. The source index also ignores frontmatter, comments and supported indented code blocks.

A resolved figure reference appears beside literal syntax in code and links.
Open larger

The preview and on-screen report are free; saved profiles and local Markdown reports need Pro.

Pro features

Pro costs $5 a month or $15 one time through GitHub Sponsors. One sponsorship turns on Pro in every plugin that has it.

Saved number and prefix profiles Pro

Current prefixes and first numbers are free settings. Pro stores named profiles for manual loading between project notes. Profiles change the current settings without selecting notes by folder.

The number profile window shows a project name and a saved profile button.
Open larger

Local label reports Pro

Create a separate Markdown report beside the active note with labels, numbers, source lines and diagnostics. Existing report paths get numbered filenames. This command does not start an export.

A saved Markdown report lists figure and equation labels with source lines.
Open larger

Set up Pandoc Crossref Preview

needs

  • Obsidian 1.13.4 or later

steps

  1. Add a standalone labelled image, a simple labelled display equation and references to a short note.

  2. Open Reading view and inspect the reference numbers.

  3. Select a number to inspect its target source line.

  4. Run Show label report before exporting with your existing tools.

If the app can't find a new plugin yet, try again later. Obsidian says a plugin that passes the review shows in the app within 24 hours.

How to preview Pandoc figure and equation references in Obsidian

Known limits of Pandoc Crossref Preview

  • Reading view is supported; Live Preview is outside the supported scope.
  • The preview supports standalone Markdown images and simple display equations within one note.
  • Tables, subfigures, chapter numbering and cross-note references are outside the supported scope.
  • Reopen Reading view after changing labels, their order or numbering settings.
  • The plugin does not run Pandoc or compare its result with exported output.
  • Saved profiles apply to current settings and do not select notes by folder.
  • Phone and tablet rendering, Windows, Linux desktop execution, real paid sponsorship and Pandoc export were not tested.

Need a change for your team? I build custom Obsidian plugins and features.

Questions about Pandoc Crossref Preview

Does this replace pandoc-crossref?

No. The preview supports simple labels in one note. Tables, subfigures, chapter numbering and cross-note references are outside its scope.

Can I use it in Live Preview?

Reading view is the supported view. Live Preview is outside the supported scope.

Will it insert numbers into my Markdown?

No. The preview and on-screen report leave the source note unchanged. A saved local report creates a separate file.

Network use

No requests occur before you select Sign in with GitHub; sign-in sends a client ID, scope and device codes to github.com. After sign-in, api.github.com receives token-authenticated sponsorship queries for tier and payment totals; successful checks cache seven days, failures retry after six hours. Refresh requests an earlier check; notes, paths and vault data stay local, with no telemetry.

Read the full network disclosure

Questions or ideas?

Tell me what is broken in Pandoc Crossref Preview, or what it should do next.

Send feedback

Pandoc Crossref Preview 1.1.0, MIT license

MIT · no telemetry · core features free