Skip to content

northy/pdf-to-markdown-workflow

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PDF To Markdown Workflow

How to use

  • Add the following lines to your source markdown file. The workflow will fill the lines between these comments with the actual image links:
<!-- PDF-TO-MARKDOWN:START -->
<!-- PDF-TO-MARKDOWN:END -->

Create the following file: .github/workflows/pdf-to-markdown.yml

name: PDF To Markdown

on:
  push:
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.8]
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Compile markdown
      uses: northy/pdf-to-markdown-workflow@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Options

Option Default Value Description Required
pdf_input Input PDF file path Yes
output_folder 'output_pngs' Output PNGs folder (don't add trailing "/") No
source_md 'source.md' Source Markdown File Yes
output_md 'README.md' Output Markdown File (CAN be the same file as the input) No
root_folder '' Change root output folder (useful for github pages) No
line_end '---\n' Appends line end to every image line on markdown No

Inspired from: