Markdown Pages

Walks the repository, eats all Markdown and spits out HTML files.

Usage

Via GitLab Pages

  1. Clone this repo
  2. Add your Markdowns
  3. Push to GitLab
  4. Watch your page get built

Locally

  1. Clone this repo
  2. Add your Markdowns
  3. npm install
  4. node convert.js
  5. Do your shenanigans with the generated HTMLs in public/

Dependencies

Template

We use a template based on the GitHub Markdown, mixed with some of our own tweaks.

Markdown flavour

We use standard Markdown with a little extra Mathjax. That essentially means that

this nice inline math: $(\forall x\in\mathbb{R}):x^2\gt0$ or this block math:

$
a^2+b^2=c^2\\
\sqrt{a^2+b^2}=c
$

turn into these pretty objects:

this nice inline math: `(\forall x\in\mathbb{R}):x^2\gt0` or this block math:

a^2+b^2=c^2\\
\sqrt{a^2+b^2}=c

License

MIT, see LICENSE.md

Contents modified on 2021-01-13 21:10:55.796+0000
Page generated on 2021-01-13 21:11:11.386+0000