Skip to content
Public template

About

A simple template for generating a web-hosted essay from a markdown file.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

108 Commits

Folders and files

Repository files navigation

DOI GitHub GitHub Actions Workflow Status

re:write

A light-weight template for generating a web-hosted essay from a markdown file through a versioned writing process.

About

This template was designed to help students write a critical essay in markdown, with automatic reference formatting via a linked .bib file, while keeping track of their own 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.

The template was developed by Wout Dillen, Senior Lecturer in Library and Information Science at the University of Borås.

Website Link

🚀 Visit the demo version here: https://sslis.github.io/rewrite/.

Technical requirements

To publish the essay with GitHub Pages, you only need a GitHub account, and to activate the deployment through Settings > Pages > Build and deployment > Source > Github Actions.

To develop the essay locally to check changes before committing, install pandoc (if you haven't already) by following the relevant instructions for your OS. Afterwards, HTML files can be generated from the markdown by navigating to the relevant directory in a terminal, and running:

make preview

Generating Word files

It is also possible to generate a Word file directly from the markdown, by similarly navigating to the relevant directory in your terminal and running:

make wordfile

This will generate a word document using the default Word template styles. If you want to make changes to these styles, you can modify the reference document in assets/template/reference.docx. To make changes, make sure that you change the styles, not just the text, by opening the Styles Pane (Home > Styles), finding the style you want to modify, and click on Modify Style (via rightclick or dropdown menu).

To make sure that your changes to the styles actually take effect, be sure to save the changes you made to reference.docx and also close the file. Changes to the styles survive longer in the cache, and may require the file to actually be closed before pandoc can access them.

Affiliations

This resource was developed during Wout's employment at the University of Borås and is affiliated to Huminfra, the Swedish national infrastructure supporting digital and experimental research in the Humanities. In that capacity, it is developed as an in-kind contribution to DARIAH-SE, the Swedish national node of DARIAH-EU (Digital Research Infrastructure for the Arts and Humanities), a Pan-European infrastructure that supports digital research and collaboration in the arts and humanities.

The Swedish School of Library and Information Science at the University of Borås Huminfra DARIAH-SE

About

A simple template for generating a web-hosted essay from a markdown file.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages