Giter VIP home page Giter VIP logo

obsidian-pandoc-templates's Introduction

Obsidian Pandoc Templates


A repository for templates. Geared for Pandoc and Obsidian.

These templates are natively included in the following Obsidian plugins:

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

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 .

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 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.

obsidian-pandoc-templates's People

Contributors

universvm avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

tsuijl winnerwind

obsidian-pandoc-templates's Issues

Title for references

Hello!
Thanks for tutorial, everything works great, almost :)
Currently the title for references doesn't render, do you know what might be the issue?
image

Cheers!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.