marmite  by rochacbruno

Markdown-powered static site generator

Created 1 year ago
863 stars

Top 40.9% on SourcePulse

GitHubView on GitHub
Project Summary

Marmite is a static site generator designed to simplify the process of creating websites from Markdown files, targeting bloggers and users frustrated by complex setup procedures. It offers a zero-configuration starting point and a single-command execution, enabling users to quickly publish content with minimal overhead.

How It Works

Marmite operates by reading Markdown files from an input directory, parsing them into HTML using CommonMark (with extensions), and extracting metadata from frontmatter or filenames. It generates individual HTML files for each page and outputs the complete static site to a specified directory, automatically handling the copying or generation of static and media assets. Its core advantage lies in its extreme simplicity and single-binary distribution, prioritizing ease of use over feature bloat.

Quick Start & Requirements

  • Primary install/run command: cargo binstall marmite or cargo install marmite. Pre-built binaries, Docker, and package manager options are also available.
  • Non-default prerequisites: Rust/Cargo for source installation. Package managers like Homebrew, AUR, or FreeBSD ports are alternatives. Docker is also supported.
  • Links:
  • Basic Usage: marmite <input_folder> <output_folder>
  • Development Server with Live Reload: marmite --serve --watch

Highlighted Details

  • Single binary distribution with zero-configuration setup.
  • Extensible Markdown parsing (CommonMark, GitHub Flavored Markdown, extensions) supporting raw HTML, emojis, wikilinks, and alerts.
  • Comprehensive content management features including taxonomies (tags, series, authors, i18n), backlinks, drafts, pagination, and built-in search.
  • Integrated development server with WebSocket live reload for automatic browser refreshes on file changes.
  • Advanced content processing: shortcodes, image galleries, automatic image resizing (parallel processing), and media organization.
  • Support for IndieWeb principles, AT Protocol integration, and embedded AI agent skills.
  • Workspace support for multi-site layouts and remote theme installation.

Maintenance & Community

Information regarding specific maintainers, community channels (e.g., Discord, Slack), sponsorships, or project roadmap is not detailed in the provided README snippet.

Licensing & Compatibility

The specific open-source license for Marmite is not explicitly stated in the provided README content. This omission requires further investigation before adoption, especially concerning compatibility for commercial use or closed-source linking.

Limitations & Caveats

Marmite is intentionally designed for simplicity and is primarily suited for bloggers focused on chronological content. Users requiring highly complex features or advanced site architectures may find its scope limited.

Health Check
Last Commit

23 hours ago

Responsiveness

Inactive

Pull Requests (30d)
58
Issues (30d)
9
Star History
10 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.