Obsidian Enhancing Export Plugin
English | 中文
This is an enhancing export plugin base on Pandoc
for Obsidian (https://obsidian.md/). It's allow you to export to formats like Markdown
,Markdown (Hugo)
,HTML
,docx
,Latex
etc.
Where Markdown
,Markdown (Hugo)
,HTML
will export and its media resource together.
Note: Markdown
,Markdown (Hugo)
,HTML
are tested in Mac OS, Windows, and Linux as I used it for myself, others are not tested well.
Ads: You might like my other plugins
Screen shot
Installation
-
First install the latest
pandoc
(2.19+), and then addpandoc
path to environment variablePATH
or set absolute path ofpandoc
in the plugin setting view.See more details in https://pandoc.org/installing.html。
-
Search
obsidian-enhancing-export
in the community plugins of obsidian, and install it.
Customize export commands
You can customize your export command by yourself, click add
in the plugin setting view and then choose template custom
to add new custom configuration.
Variables
You can use ${variables}
in custom export command, their values are:
Key | Value |
---|---|
${outputPath} |
Output file path after export. For example, if your export to location /User/aaa/Documents/test.pdf , then ${outputDir} will be replace that path. |
${outputDir} |
Output directory of saved exported file,It will be /User/aaa/Documents in above case. |
${outputFileName} |
File name (without extension) of the saved exported file. It will be test in above case. |
${outputFileFullName} |
File name (with extension) of the saved exported file. It will be test.pdf in above case. |
${currentPath} |
Path of currently edited file. For example, if your are editing /User/aaa/Documents/readme.md , the the value will be /User/aaa/Documents/readme.md . |
${currentDir} |
Current directory of currently edited file, It will be/User/aaa/Documents in above case. |
${currentFileName} |
Filename without extension of currently edited file, It will be readme in above case. |
${currentFileFullName} |
Filename with extension of currently edited file. It will be readme.md in above case. |
${vaultDir} |
The obsidian current vaultDir. |
${attachmentFolderPath} |
The attachmentFolderPath of Obsidian. |
Others variables | You can use keyword: value in YAML Front Matter, then use ${metadata.keyword} |
Related resources
- Tutorial: Obsidian Tutorial for Academic Writing - tutorial on how to setup this plugin and use it for academic writing (export to
.docx
,.pdf
,.tex
,.bib
) - A collection of lua filters for pandoc: https://github.com/pandoc-ext - Filters and other goodies to get the most out of pandoc, the universal document converter.
- Math latex editor: https://math.yish.org/
Finally
- Welcome to provide more command templates to here.
- Feel free to file an issue for any questions.