Markdown to GitLab style web

Thanks Felix Krause, this is the clone of Markdown to GitHub style web

Background

If you have a little side project, often you might want a simple landing page. The GitLab README rendering is really beautifully done: clean, simple and modern.

Using your GitLab README as the main landing point works great for open source projects, where your visitors are developers and are familiar with GitLab, as well as you have all the text right where the code, the Issues and MRs are. But for some projects this isn't ideal.

Solution

A simple script that converts a markdown (.md) file to a single HTML file, that includes all the HTML and CSS code inline, so you can host it anywhere.

There is no need to use this script if you already convert your markdown file to HTML, you can directly use the stylesheet of this repo.

How it works

This project doesn't actually use the GitLab stylesheet, it's far too complex, and has legal implications.

Instead this project does 2 things:

Resulting you get an HTML file that contains everything needed, so you can host the page on GitLab pages, AWS S3, Google Cloud Storage or anywhere else.

Usage

node convert.js MyPageTitle

Open tasks

Check out the open issues, in particular code blocks currently don't support syntax highlighting, however that's something that's rather easy to add.

Playground to test

{
  testcode: 1
}

  1. Numbered list item 1
  2. Numbered list item 2

Inline code comments are 100

Quoted texts are more gray and look differently

Bold text is bold and inline links work as well.

Header 1

Header 2

Header 3

Header 4

Header 5
Header 6

Normal text content again, lorem ipsum

Text 1 Text 2 Text 3
Text 1 Text 2 Text 3
Text 1 Text 2 Text 3

🔰 Raw HTML code for custom style 🔰