Skip to content

Combining Documents

Jump to bottom
OliverBalfour edited this page Jun 26, 2021 · 4 revisions

A common use case for this plugin is to stitch together large documents where each page or chapter is an individual note.

Using Obsidian's note embedding syntax

You can embed notes in other notes using ![[note name]] syntax. This plugin gives links like this special treatment regardless of plugin settings. The output is designed to be completely seamless - ![[note]] is literally replaced with the contents of note.md before invoking Pandoc.

Using YAML to configure metadata

You can add title, author, etc. fields which Pandoc will give special treatment to in the YAML front matter. (For more info on YAML metadata fields, see the docs and some caveats.)

Complete example

---
title: My Awesome Book
subtitle: How you can make one too
author: Oliver
date: 1 January 2000
---

![[Chapter1]]
![[Chapter2]]
![[Chapter3]]
![[Glossary]]

Further information

Bugs:

Useful tips:

  • If you want to export a folder as one document without manually creating a file of ![[includes]], see the instructions here. (Requires some command-line foo and will only work on Mac/Linux, or Windows in WSL or Git Bash)

Feature requests: (if these would be useful for you, just hit the 👍 react on the issue)

Clone this wiki locally