Skip to content

thhaase/markdown2website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview

This project is a lightweight and simple tool that converts markdown files into a minimalist webpages.

It's build with a minimalist mindset wich makes it highly flexible and easy to use:

  1. copy the source folder and index.html in a folder
  2. add all markdownfiles
  3. make a homepage via creating a startpage.md. Use it to link all other markdownfiles
  4. for further customization (titles, headerbar,...) edit the index.html and source/page.html file

✨ voilà ✨ ...that's it! To create a public Website upload your folder to Github and activate GithubPages with main/root.

Take a look!


Inspiration and Background

The Inpiration for this project were the many lightweight RegEx-based parser from the Github User Casualwriter. The thought of a really simple, selfcontained and minimalistic Markdown ==> Website tool was fascinating.
Also this is a nice way to share notes or documents. That's why I included the themeswitch and print button.