Giter VIP home page Giter VIP logo

scholarly-pandoc's Introduction

README

This is my setup for rich scholarly markdown.

Disclaimer

Most of the templates and scripts are developed or inspired by others. I've only made minor changes to tailor the style to my own preferences.

Installation

  • Clone this repository.
  • Install the dependencies:
    • Texlive full package:sudo apt-get install texlive-full
  • If it does not exist create ~/.pandoc directory
  • Copy all the right files to all the right places
cp -r templates ~/.pandoc/.
cp -r csl ~/.pandoc/.
cp -r css ~/.pandoc/.
  • There are some additional tex dependencies (memoir-article-styles.sty,org-preamble-pdflatex.sty) you can either keep them in the same directory as the markdown input files. Or you can place them in the general tex folder (for me this is ~/.texmf/)
  • Pandoc-crossref package is used which combined fignos, eqnos, etc. into one package. Installing this package was a quite a hassle. Check your pandoc version pandoc -v and download the respective crossref release version. In the pandoc commands, point to the right location on your computer with the filter flag --filter yourPath/pandoc-crossref

Usage

  • Go to the example directory and run make to build the .docx .tex .pdf files from template.md
  • Use make clean to clean the directory
  • This setup works perfectly with atom's markdown preview enhanced package.
    • Select 'use Pandoc Parser'
    • Set pandoc path (usually /usr/bin/pandoc)
    • Set the command line arguments: --template=/home/name/.pandoc/templates/html.template, --filter=/home/name/.pandoc/filters/pandoc-crossref, --filter=pandoc-citeproc, --bibliography=/path/libraryName.bib,--csl=/home/name/.pandoc/csl/apsa.csl
    • Set the pandoc options: markdown+simple_tables+table_captions+yaml_metadata_block
    • Warning hacky approach: If the spinning octocat in atom is driving you completely bonkers just find and eliminate the little bugger
      • For cautious people: find ~/.atom/packages -name "*octocat-spinner*" and remove all the files related to markdown-preview-enhanced
      • For badasses: find ~/.atom/packages -name "*octocat-spinner*" | xargs rm
      • For vscode `find ~/.vsc/extensions/ -name "octocat-spinner"

Credits

I've got most of the material from Kieran Healy's setup:

Changes:

  • removed VC package
  • removed proprietary font minonPro from the tex templates
  • changes to css stylesheets
  • addition of pandoc-crossref package

scholarly-pandoc's People

Contributors

beramos avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

pbt001

scholarly-pandoc's Issues

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.