md-press

Publish Markdown documents for free with md-press.

Quick start

name: Publish

on:
  push:
    branches: [main]

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  publish:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.md-press.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4
      - uses: alDuncanson/[email protected]
        id: md-press

Note

Your repository must have GitHub Pages enabled with GitHub Actions as the source. Go to Settings → Pages → Source → select "GitHub Actions".

This converts document.md into a PDF, an HTML page, and a preview image, then deploys everything to GitHub Pages.

See my resume for a single-document publishing example, or essays for a multi-document example.

Configuration

The defaults work for a single-document workflow, but md-press supports custom filenames, multi-file publishing, and PDF styling through YAML frontmatter.

See docs/configuration.md for the full reference.