Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rochacbruno/marmite
Markdown makes sites - A Static Site Generator for Blogs
https://github.com/rochacbruno/marmite
blog blog-engine cms hacktoberfest hacktoberfest-accepted markdown rust rustlang site ssg static static-blog-generator static-site static-site-generator
Last synced: 6 days ago
JSON representation
Markdown makes sites - A Static Site Generator for Blogs
- Host: GitHub
- URL: https://github.com/rochacbruno/marmite
- Owner: rochacbruno
- License: agpl-3.0
- Created: 2024-10-14T17:31:42.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-06T11:48:18.000Z (18 days ago)
- Last Synced: 2025-01-11T15:00:27.190Z (13 days ago)
- Topics: blog, blog-engine, cms, hacktoberfest, hacktoberfest-accepted, markdown, rust, rustlang, site, ssg, static, static-blog-generator, static-site, static-site-generator
- Language: Rust
- Homepage: https://rochacbruno.github.io/marmite/
- Size: 8.03 MB
- Stars: 489
- Watchers: 4
- Forks: 22
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-static-generators - Marmite - Zero Config, Simple and fast, just run it on a folder with markdown files and done! `#Rust` (Uncategorized / Uncategorized)
README
# Marmite
Marmite [**Mar**kdown **m**akes s**ite**s] is a **very!** simple static site generator.
[](http://www.gnu.org/licenses/agpl-3.0)
[](https://crates.io/crates/marmite)
[](https://rochacbruno.github.io/marmite/)
[](https://github.com/rochacbruno/blog)
> I'm a big user of other SSGs but it is frequently frustrating that it takes so much setup to get started.
Just having a directory of markdown files and running a single command sounds really useful.
— Michael, marmite user.
## How it works
It does **"one"** simple thing only:
- Reads all `.md` files on the `input` directory.
- Using `CommonMark` parse it to `HTML` content.
- Extract optional metadata from `frontmatter` or `filename`.
- Generated `html` file for each page.
- Outputs the rendered static site to the `output` folder.
It also handles generating or copying `static/` and `media/` to the `output` dir.
## Before you start, you should know
1. Marmite is meant to be simple, don't expect complex features
2. Marmite is for **bloggers**, so writing and publishing articles in chronological order is the main use case.
3. The generated static site is a **flat** HTML site, no subpaths, all content is published in extension ending URLS ex: `./{name}.html|rss|json`
4. There are only 2 taxonomies `tags:` (to group similar content together) and `stream:` (to separate content in a different listing)
5. Marmite uses the `date:` attribute to differentiate `posts` from `pages`
## Features
- Everything embedded in a single binary.
- Zero-Config to get started.
- optionally fully configurable
- Common-mark + Github Flavoured Markdown + Extensions.
- Raw HTML allowed.
- Emojis `:smile:`, spoiler `||secret||`.
- Wikilinks `[[name|url]]` and Obsidian links `[[page]]`.
- Backlinks.
- Tags.
- Multi authors.
- Author profile page
- Multi streams.
- Separate content in different listing
- Pagination.
- Static Search Index.
- RSS Feeds.
- Multiple feeds (index, tags, authors, streams)
- Built-in HTTP server.
- Auto rebuild when content changes.
- Built-in theme
- Light and Dark modes.
- Multiple colorschemes
- Fully responsive
- Spotlight Search.
- Easy to replace the index page and add custom CSS/JS
- Easy to customize the templates
- Math and Mermaid diagrams.
- Syntax Highlight.
- Commenting system integration.
- Banner images and `og:` tags.
- CLI to start a new theme from scratch
## Installation
Install with cargo
```bash
cargo binstall marmite
```
or
```bash
cargo install marmite
```
Or download the pre-built **binary** from the [releases](https://github.com/rochacbruno/marmite/releases)
Or use docker
> [!IMPORTANT]
> The directory containing your marmite project must be mapped to containers `/input`
> If running inside the directory use `$PWD:/input`
> The result will be generates in a `site` folder inside the input dir.
Build
```console
$ docker run -v $PWD:/input ghcr.io/rochacbruno/marmite
Site generated at: site/
```
Serve (just add port mapping and the --serve)
```console
$ docker run -p 8000:8000 -v $PWD:/input ghcr.io/rochacbruno/marmite --serve
```
> [!INFO]
> By default will run `:latest`, Add `:x.y.z` with the version you want to run.
## Usage
It's simple, really!
```console
$ marmite folder_with_markdown_files path_to_generated_site
Site generated at path_to_generated_site/
```
CLI
```console
❯ marmite --help
Marmite is the easiest static site generator.
Usage: marmite [OPTIONS]
Arguments:
Input folder containing markdown files
Output folder to generate the site
Options:
--serve Serve the site with a built-in HTTP server
--watch Detect changes and rebuild the site automatically
--bind Address to bind the server [default: localhost:8000]
--config Path to custom configuration file [default: marmite.yaml]
--debug Print debug messages Deprecated: Use -vv for debug messages
--init-templates Initialize templates in the project
--start-theme Initialize a theme with templates and static assets
--generate-config Generate the configuration file
-v, --verbose... Verbosity level (0-4) [default: 0 warn] options: -v: info,-vv: debug,-vvv: trace,-vvvv: trace all
-h, --help Print help
-V, --version Print version
```
## Getting started
Read a tutorial on how to get started https://rochacbruno.github.io/marmite/getting-started.html and create your blog in minutes.
## Docs
Read more on how to customize templates, add comments etc on https://rochacbruno.github.io/marmite/
## That's all!
**Marmite** is very simple.
If this simplicity does not suit your needs, there are other awesome static site generators.
Here are some that I recommend:
- [Cobalt](https://cobalt-org.github.io/)
- [Zola](https://www.getzola.org/)
- [Zine](https://zineland.github.io/)