How to use this template
About
This template helps students write a critical essay in
markdown, with automatic reference formatting via a linked
.bib file, while keeping track of their writing
process through git’s versioning system. The template uses a
built-in workflow for visualising and publishing the essay with
GitHub Pages, and/or developing the essay locally with
pandoc.
Quickstart
To get started with this template, follow these quick steps. More detailed instructions for each of the steps are linked below. This guide assumes that you will want to take advantage of both the template’s local and online workflows.
- Install the requirements
- Add the template to your GitHub account
- Clone the template to your local machine
- Start writing your essay in
essay.mdand adding references inreferences.bib - Run
make previewto (re)generateindex.htmland check your progress - Commit changes and push them to the remote to publish your essay
Check out the demo (and the markdown file it is generated from) to learn more about how to format your essay in markdown, and be sure to check out our Crash Course in Academic Writing (CCAW) for some tips to help you write the essay.
How to …
- …install the requirements
- …clone the template?
- …write your essay in markdown?
- …cite your references in BibTex?
- …review your progress locally in the browser?
- …track your progress through commits?
- …publish your changes online?