Setup Mark

GitHub Action to install Mark, the Markdown publishing tool, and optional dependencies.

Usage

steps:
  - uses: actions/checkout@v4
  - uses: accuser/setup-mark@v1

With optional dependencies

steps:
  - uses: actions/checkout@v4
  - uses: accuser/setup-mark@v1
    with:
      python: true          # for code execution
      python-version: "3.12"
      typst: true           # for PDF output
      pagefind: true        # for search indexing

Inputs

Input	Default	Description
mark-version	latest	Mark version (latest or a specific version like 0.3.0)
python	false	Install Python with jupyter_client and ipykernel
python-version	3.12	Python version (when python: true)
typst	false	Install Typst for PDF output
pagefind	false	Install Pagefind for search indexing

Outputs

Output	Description
mark-version	The resolved version that was installed

Version pinning

Pin to a major version for automatic compatible updates:

- uses: accuser/setup-mark@v1

Pin to a specific version for reproducibility:

- uses: accuser/setup-mark@v1.0.0

Examples

See the examples/ directory for complete workflow files:

• simple-website.yml — website with GitHub Pages
• book-with-code.yml — book with Python code and PDF
• pr-preview.yml — PR deploy previews with Netlify

License

MIT