Markdown

Return to top README.md

Markdown Linting

We cam control markdown linting with a .markdownlint.yaml file in conjunction with the markdownlint VS Code extension. An example of such a file is included in this directory.

To use this configuration:

• Install the markdownlint extension in VS Code
• The .markdownlint.yaml file will be automatically detected and applied to markdown files in this directory
• You can also run markdownlint from the command line with npx markdownlint *.md to check files manually

Code Blocks

Formatting code block guide, listof available tags

Some useful tags:

Batchfile	Jupyter Notebook	R
BibTeX	Makefile	bash
Click	Markdown	SQL
CSV	Numpy	TeX
Dockerfile	Pickle	Text
GraphQL	PowerShell	TOML
Ignore List	Python	Vim Snippet
JSON	Python console	XML
JSON with Comments	Python traceback	YAML

LaTeX equation formatting for Markdown

In a Markdown file, the following syntax

$y=mx+b$

displays as $y=mx+b$

YAML Header

Guide

dillinger.io

dillinger.io is an easy option to convert markdown to pdf. However, have to copy paste into the web-browser.

However, would have to figure out how to customize as needed (e.g. add page numbers, add page breaks)

Pandoc

Pandoc is a document converter. I have been using it to convert from .md to .pdf. Specifically, I have been using the VSCode extension vscode-pandoc.

Additionally, here the setting I use:

Docker

PDF Options

Here I have changed the output font size and margin spacing.

-V fontsize=12pt -V geometry:margin=1in -V colorlinks=true -V linkcolor=blue -V urlcolor=blue -V toccolor=gray

Running Pandoc

While viewing the .md file of interest, open the Command Palette (ctrl + shift + p) and look for and select Pandoc Render

You will then have some options of the output format, we will use pdf

If successful, this will run a Docker container and produce a pdf.

Markdeep

Markdeep. Seems to have example .md.html files that have decent styling and can be opened via a browser. Maybe been good for making webpages. Not clear if there is a way to then also convert to .pdf.