DwieDima / paper

A template to write papers, that automatically generate cool HTML files, prepared to be accessed via GitHub Pages.

Use this as a template for writing your paper. It will automatically build a cool HTML that contains all your citations like here.

1. Install pandoc (prerequisite!)
2. Use this repo as template (!= fork)
3. Copy pre-commit into your .git/hooks folder
4. Write your paper (in paper.md)
5. Add citations by adding
   1. the book/article/.. you cite in bibliography.bib
   2. [@citation_handle] in your text
6. Make a git commit. (The pre-commit hook will generate your HTML automatically.)

Optional steps:
7. If you want to rename paper.md, rename it's reference in .git/hooks/pre-commit as well
8. If you want to generate your HTML without commiting, execute pandoc --citeproc paper.md --standalone -o index.html
9. If you want your paper to be accessible as a website, activate Github Pages by going to Settings -> GitHub Pages and selecting Master as source branch

Tooling proposal:

• Visual Studio Code
• VSC Extensions
  • Pandoc Citer
  • Markdown All in One
  • bibtexLanguage
• Brain