https://github.com/boardfish/waxseal

Give it Markdown and it gives back LaTeX-compiled PDFs using your template.
https://github.com/boardfish/waxseal

Last synced: 2 months ago
JSON representation

Give it Markdown and it gives back LaTeX-compiled PDFs using your template.

• Host: GitHub
• URL: https://github.com/boardfish/waxseal
• Owner: boardfish
• Created: 2017-05-28T14:06:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-05-31T08:21:33.000Z (over 2 years ago)
• Last Synced: 2024-10-07T09:19:40.230Z (3 months ago)
• Language: Shell
• Homepage:
• Size: 400 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Waxseal

Waxseal is a GitHub Action you can use to compile Markdown documents with

Pandoc. Add your Markdown documents to an input directory, then let Waxseal put

it through your TeX/Pandoc template for that extra bit of shine.

## Usage

Configure your GitHub Actions workflow using something like this:

```yaml

# This is a basic workflow to help you get started with Actions

name: CI

on: [push]

jobs:

  waxseal_job:

    runs-on: ubuntu-latest

    name: Waxseal

    steps:

      - name: Checkout

        uses: actions/checkout@v2

        with:

          # Make sure the actual branch is checked out when running on pull requests

          ref: ${{ github.head_ref }}

      - name: Waxseal it

        uses: boardfish/[email protected]

        id: waxseal

        with:

          input_directory: 'in'     # Takes .md files from ./in...

          output_directory: 'out'   # ...and compiles them to PDFs in ./out...

          template_file: 'template.tex' # ...using the template at template.tex.

```

Now, whenever you add or change a Markdown file in the `in` directory, Waxseal

will run it through the template you've provided.

To get a starter template, install `pandoc` locally and run `pandoc -D latex >

template.tex`. You should commit this template to your repo.