Skip to content

Getting started

This page takes you from installation to your first exported report in about five minutes.

Install the plugin

  1. In Obsidian, open Settings → Community plugins. If needed, turn off Restricted mode.
  2. Click Browse, search for Report Exporter, then Install and Enable.
  1. Download main.js, manifest.json and styles.css from the latest release.
  2. Put them in <your vault>/.obsidian/plugins/pdf-report-exporter/.
  3. Restart Obsidian, then enable Report Exporter in Settings → Community plugins.

The plugin works on Obsidian 1.8.7 or later, desktop only.

Export your first report

  1. Open a note, or create one with a few headings and paragraphs.
  2. Run Insert report frontmatter from the command palette (Ctrl+P / Cmd+P). It adds a pre-filled block at the top of the note:

    ---
    title: Website Migration Review
    client: ACME Corp
    subtitle: Infrastructure team
    versions:
      - version: "1.0"
        date: "2026-10-19"
        status: "Document created"
    contacts:
      - name: "Jane Doe"
        role: "Project lead"
        email: "jane.doe@example.com"
    ---
    
  3. Fill in the title and client, then run Preview PDF report. The PDF opens in an Obsidian tab; run the preview again after each change.

  4. When it looks right, run Export as PDF report. The file is written to the vault root, or to the output folder set in the settings, and a notice offers to open it or show it in its folder.

Table of contents page generated from the note's headings

Every way to export

How What it does
Export as PDF report command, or the ribbon icon Exports the active note
Preview PDF report command Renders the PDF and opens it inside Obsidian, reusing the same file and tab
Export selection as PDF report command Exports only the selected text
Export as PDF report with a profile… command Exports one version: the full one, or a profile such as Client — see Confidential export
Export all versions as PDF reports command Writes the full version and one PDF per profile
Export as Word document command, with or without a profile Writes the same report as a .docx — see Word export
Right-click a note in the file explorer Exports that note
Right-click a folder Exports every note in it, one PDF each, with a summary at the end

When you have several templates, a picker asks which one to use. It is skipped when there is only one, when the note names one with template: in its frontmatter, or once you tick Don't ask again.

Where to go next