Skip to content

Action that converts markdown files to PDF

License

Notifications You must be signed in to change notification settings

chfanghr/md-to-pdf

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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...

  1. Checkout the code
  2. Convert all markdown files (.md) to .pdfs, Note: You can filter the paths to only run on certain file types.
  3. 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/checkout@v2.0.0
      with:
        fetch-depth: 1
    - name: Create .pdfs
      uses: scottypate/md-to-pdf@v0.1.1
      env: {
        # Use this parameter to determine where the generated .pdf(s) will be stored.
        PDF_DIR: './pdfs'
      }
    - name: Create Pull Request
      uses: peter-evans/create-pull-request@v1.6.1
      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

About

Action that converts markdown files to PDF

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Dockerfile 69.0%
  • Shell 31.0%