https://github.com/jaantollander/markdown-templates

Templates for creating scientific, academic and technical documents using Markdown and Pandoc that support equations, code blocks, citations, Unicode symbols and vector graphics.
https://github.com/jaantollander/markdown-templates

citations essay latex markdown pandoc scientific-writing slides template

Last synced: 6 days ago
JSON representation

Templates for creating scientific, academic and technical documents using Markdown and Pandoc that support equations, code blocks, citations, Unicode symbols and vector graphics.

• Host: GitHub
• URL: https://github.com/jaantollander/markdown-templates
• Owner: jaantollander
• License: mit
• Created: 2018-01-12T13:55:36.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-07T09:09:59.000Z (over 1 year ago)
• Last Synced: 2024-08-03T22:20:04.124Z (3 months ago)
• Topics: citations, essay, latex, markdown, pandoc, scientific-writing, slides, template
• Language: HTML
• Homepage: https://jaantollander.com/post/scientific-writing-with-markdown/
• Size: 2.62 MB
• Stars: 190
• Watchers: 7
• Forks: 55
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Markdown Templates

## Introduction

This repository contains templates for creating scientific, academic, and technical documents that require equations, citations, code blocks, Unicode characters, and embedded vector graphics using *Markdown* and *Pandoc* converter. This software also allows us to write LaTeX documents more easily compared to using pure LaTeX. We discuss the details about these templates and how to write scientific Markdown in general in our article [*Scientific Writing with Markdown*](https://jaantollander.com/post/scientific-writing-with-markdown/). The original inspiration came from the article [*How to make a scientific-looking PDF from Markdown (with bibliography)*](https://gist.github.com/maxogden/97190db73ac19fc6c1d9beee1a6e4fc8).

## Requirements

To use these templates, we require the following software.

1) [*Pandoc*](https://pandoc.org/) for converting between the Markdown files into other document formats.

2) [*LaTeX*](https://www.latex-project.org/) for creating PDF documents.

3) Shell such as Bash for invoking the build scripts.

Then, clone the repository and copy the appropriate template.

## Editors

![](images/markdown-templates-vscode.png)

Above, we see how writing documents looks in *Visual Studio Code*.

![](images/markdown-templates-atom.png)

Above, we see how writing documents looks in *Atom*.

We also recommend having an editor for writing Markdown. Please read the [Editors](https://jaantollander.com/post/scientific-writing-with-markdown/#editors) section in our article.

## Creating Documents

The [Creating Documents](https://jaantollander.com/post/scientific-writing-with-markdown/#creating-documents) section in our article explains the template directory structure, build commands and makefiles, and how to set document-specific metadata in the front matter.