Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/universvm/obsidian-pandoc-templates

A repository for pandoc templates. Geared for Obsidian.
https://github.com/universvm/obsidian-pandoc-templates

academic academic-paper latex latex-template markdown markdown-to-pdf obsidian obsidian-md pandoc pandoc-template pdf

Last synced: 6 days ago
JSON representation

A repository for pandoc templates. Geared for Obsidian.

Awesome Lists containing this project

README

        

# Obsidian Pandoc Templates




A repository for templates. Geared for Pandoc and Obsidian.

These templates are natively included in the following Obsidian plugins:

- [Obsidian Enhancing Export](https://github.com/mokeyish/obsidian-enhancing-export/)

## Why Templates?

I wanted an easy way to produce graphically-pleasing academic documents from my Obsidian notes.

Obsidian (+pandoc) is easy to use, can handle LaTeX-style citations, figure references, and export to `.tex`, `.pdf`, `.bib` and so on.

## How to use?

### Complete Set Up

A step-by-step guide is available here: [Obsidian Tutorial for Academic Writing](https://betterhumans.pub/obsidian-tutorial-for-academic-writing-87b038060522)

It will guide you through syncing Zotero and Obsidian, setting up Pandoc, and referencing figures and citations.

### Partial Set Up

If you just want to install the templates in your pandoc:

1. Type `pandoc --version` in the terminal
2. Find the User data directory: e.g. `/Users/leo/.local/share/pandoc`
3. If the folder above does not exist, create it.
4. Copy the folder of your template(s) of interest in there.

If you need more guidance, look into Section 4 of the [Obsidian Tutorial for Academic Writing](https://betterhumans.pub/obsidian-tutorial-for-academic-writing-87b038060522) .

## Contributing

Do you have a Pandoc Template? Open a pull request!

Templates should be added in the following formats:

```
TemplateName/
├─ example/
│ ├─ TemplateName.md
│ ├─ TemplateName.pdf
│ ├─ TemplateName.png
├─ TemplateName.tex
├─ TemplateName.sty
├─ README
├─ LICENSE
```

The `README` file should contain a description of the template.

The `example` folder should contain the markdown `.md` file used to generate the folder and the output PDF `.pdf` file generated.

`example.png` is a preview of the template, typically the first few pages of the PDF. Use the following [ImageMagick](https://imagemagick.org) command:

```
convert example.pdf +append -alpha remove -alpha off example.png
```

You may include additional files such as image (sparingly) and `.bib` files.

### Can I use this repository for my plugin?

Yes, please open a pull request so we can keep track of the plugins and add you to the list above.