Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/memowe/md-party
A lightweight library to dynamically generate a full website from markdown files.
https://github.com/memowe/md-party
client content-management markdown website
Last synced: 9 days ago
JSON representation
A lightweight library to dynamically generate a full website from markdown files.
- Host: GitHub
- URL: https://github.com/memowe/md-party
- Owner: memowe
- License: mit
- Created: 2020-10-21T09:58:14.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-07T16:31:43.000Z (over 2 years ago)
- Last Synced: 2023-04-20T13:59:25.982Z (over 1 year ago)
- Topics: client, content-management, markdown, website
- Homepage: http://mirko.westermeier.de/md-party/documentation/
- Size: 56.6 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
MD-Party - markdown page gathering
==================================
**A lightweight library to dynamically generate a full website from markdown files.**
## Concepts
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:
```html
MDParty([
'Welcome',
'Once upon a time',
'Concepts',
'About us',
'Partners',
], {
title: 'Awesome thing 2000',
});
```
Both arguments can be replaced with (local or remote) URLs to YAML files:
**`index.html`**:
```html
MDParty('sitemap.yml', 'config.yml');
```
**`sitemap.yml`**:
```yaml
- Welcome
- Once upon a time
- Concepts
- About us
- Partners
```
**`config.yml`**:
```yaml
title: Awesome thing 2000
```
**Note**: a footer markdown part can be loaded from a file `footer.md`, by default from `Content` as well.
## Author and License
Copyright (c) [Mirko Westermeier][mirko] ([\@memowe][mgh], [[email protected]][mmail])
Released under the MIT (X11) license. See [LICENSE][mit] for details.
[mirko]: http://mirko.westermeier.de
[mgh]: https://github.com/memowe
[mmail]: mailto:[email protected]
[mit]: LICENSE