A lightweight library to dynamically generate a full website from markdown files.
MD-Party generates a fast, clean and responsive website from your markdown files. For a given directory, accessible via HTTP on the same server or somewhere else, the complete website can be built with minimum effort:
Content directory of markdown files (alphabetical order):
Content:
|- About_us.md
|- Concepts.md
|- One_upon_a_time.md
|- Partners.md
`- Welcome.md
Minimal container website index.html including navigation order definition and configuration:
<!doctype html>
<html>
<head>
<meta charset="utf-8"/>
<title></title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/memowe/[email protected]/dist/md-party.min.css">
</head>
<body>
<script src="https://cdn.jsdelivr.net/gh/memowe/[email protected]/dist/md-party.min.js"></script>
<script>
MDParty([
'Welcome',
'Once upon a time',
'Concepts',
'About us',
'Partners',
], {
title: 'Awesome thing 2000',
});
</script>
</body>
</html>Both arguments can be replaced with (local or remote) URLs to YAML files:
index.html:
MDParty('sitemap.yml', 'config.yml');sitemap.yml:
- Welcome
- Once upon a time
- Concepts
- About us
- Partnersconfig.yml:
title: Awesome thing 2000Note: a footer markdown part can be loaded from a file footer.md, by default from Content as well.
Copyright (c) Mirko Westermeier (@memowe, [email protected])
Released under the MIT (X11) license. See LICENSE for details.