md-to-pdf's Introduction

Markdown to PDF Action

This action will find any markdown, .md, files and generate a .pdf file for each one. This action can be used in conjunction with a commit action to add the generated .pdf back to the repository. The example shows how to...

Checkout the code
Convert all markdown files (.md) to .pdfs, Note: You can filter the paths to only run on certain file types.
Open a PR back to the repo with the generated .pdfs.

This action uses the pandoc library installed on Ubuntu.

Example

name: Convert PDF to Markdown

on:
  push:
    paths:
    - '**.md'

jobs:
  convert_md: 
    runs-on: ubuntu-latest
    steps:
    # We must checkout the latest version of the code to get a copy of all .md files
    - name: Checkout Code
      uses: actions/[email protected]
      with:
        fetch-depth: 1
    - name: Create .pdfs
      uses: scottypate/[email protected]
      env: {
        # Use this parameter to determine where the generated .pdf(s) will be stored.
        PDF_DIR: './pdfs'
      }
    - name: Create Pull Request
      uses: peter-evans/[email protected]
      env:
        # The token is built in to actions. No config required.
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        COMMIT_MESSAGE: Add .pdf files.
        PULL_REQUEST_TITLE: Add .pdf files.
        PULL_REQUEST_BRANCH: pdf-add
        PULL_REQUEST_BODY: :wave: Here are the .pdf files you requested.
        PULL_REQUEST_REVIEWERS: scottypate

Recommend Projects