Skip to content

multi-file support#3

Merged
alDuncanson merged 9 commits intomainfrom
multi-file-support
Jan 7, 2026
Merged

multi-file support#3
alDuncanson merged 9 commits intomainfrom
multi-file-support

Conversation

@alDuncanson
Copy link
Copy Markdown
Owner

This pull request adds support for multi-file mode to the GitHub Action, allowing users to convert multiple Markdown files into a static site with HTML pages and a combined PDF. The workflow and documentation have been updated to support both single-file and multi-file publishing, including improvements to artifact naming and preview comments. The most important changes are grouped below.

Multi-file mode support:

  • Added a new sources input to action.yml for specifying multiple Markdown files or glob patterns; files are resolved and processed as a group. [1] [2]
  • Implemented new workflow steps in action.yml for generating a combined PDF, converting each Markdown file to HTML (preserving directory structure), and auto-generating an index page with a table of contents. [1] [2]
  • Added a Lua filter (filters/mdlinks-to-html.lua) to rewrite relative Markdown links to .html in the generated HTML, ensuring cross-file navigation works.

Workflow and artifact improvements:

  • Updated .github/workflows/test.yml to add separate jobs for single-file and multi-file tests, with distinct artifact names and verification steps for multi-file output. [1] [2]
  • Enhanced the PR comment in the workflow to clearly list all generated artifacts for both single-file and multi-file modes.

Documentation updates:

  • Updated README.md and action.yml descriptions to explain the new multi-file mode, inputs, and output structure, including usage examples and behavior differences. [1] [2] [3]

These changes make it possible to publish multiple Markdown documents as a static site and improve clarity and usability for both modes.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 5, 2026

Test Build Preview

Generated from 668bbb9

Artifacts

Download the generated files from the workflow run:

Single-file mode (test-output-single):

  • resume.pdf
  • index.html
  • preview.png

Multi-file mode (test-output-multi):

  • docs.pdf (combined)
  • index.html (auto-generated TOC)
  • docs/index.html
  • docs/guides/getting-started.html
  • docs/guides/advanced.html
  • preview.png

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 5, 2026

Test Build Preview

Generated from fd83366

Artifacts

Download the generated files from the workflow run:

Single-file mode (test-output-single):

  • resume.pdf
  • index.html
  • preview.png

Multi-file mode (test-output-multi):

  • docs.pdf (combined)
  • index.html (auto-generated TOC)
  • docs/index.html
  • docs/guides/getting-started.html
  • docs/guides/advanced.html
  • preview.png

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 5, 2026

Test Build Preview

Generated from 13327f9

Artifacts

Download the generated files from the workflow run:

Single-file mode (test-output-single):

  • resume.pdf
  • index.html
  • preview.png

Combined mode (test-output-combined):

  • docs.pdf (combined)
  • index.html (auto-generated index)
  • docs/*.html (individual pages)
  • preview.png

Collection mode - flat (test-output-collection-flat):

  • resume.pdf, cover-letter.pdf, references.pdf
  • resume.html, cover-letter.html, references.html
  • *-preview.png (one per document)

Collection mode - nested (test-output-collection-nested):

  • projects/web/.pdf, projects/mobile/.pdf
  • projects/web/.html, projects/mobile/.html
  • *-preview.png (one per document)

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 5, 2026

Test Build Preview

Generated from a13516e

Artifacts

Download the generated files from the workflow run:

Single-file mode (test-output-single):

  • resume.pdf
  • index.html
  • preview.png

Combined mode (test-output-combined):

  • docs.pdf (combined)
  • index.html (auto-generated index)
  • docs/*.html (individual pages)
  • preview.png

Collection mode - flat (test-output-collection-flat):

  • resume.pdf, cover-letter.pdf, references.pdf
  • resume.html, cover-letter.html, references.html
  • *-preview.png (one per document)

Collection mode - nested (test-output-collection-nested):

  • projects/web/.pdf, projects/mobile/.pdf
  • projects/web/.html, projects/mobile/.html
  • *-preview.png (one per document)

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 6, 2026

Test Build Preview

Generated from 310802a

Artifacts

Download the generated files from the workflow run:

Single-file mode (test-output-single):

  • resume.pdf
  • index.html
  • preview.png

Combined mode (test-output-combined):

  • docs.pdf (combined)
  • index.html (auto-generated index)
  • docs/*.html (individual pages)
  • preview.png

Collection mode - flat (test-output-collection-flat):

  • resume.pdf, cover-letter.pdf, references.pdf
  • resume.html, cover-letter.html, references.html
  • *-preview.png (one per document)

Collection mode - nested (test-output-collection-nested):

  • projects/web/.pdf, projects/mobile/.pdf
  • projects/web/.html, projects/mobile/.html
  • *-preview.png (one per document)

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 6, 2026

Test Build Preview

Generated from 1850866

Artifacts

Download the generated files from the workflow run:

Single-file mode (test-output-single):

  • resume.pdf
  • index.html
  • preview.png

Combined mode (test-output-combined):

  • docs.pdf (combined)
  • index.html (auto-generated index)
  • docs/*.html (individual pages)
  • preview.png

Collection mode - flat (test-output-collection-flat):

  • resume.pdf, cover-letter.pdf, references.pdf
  • resume.html, cover-letter.html, references.html
  • *-preview.png (one per document)

Collection mode - nested (test-output-collection-nested):

  • projects/web/.pdf, projects/mobile/.pdf
  • projects/web/.html, projects/mobile/.html
  • *-preview.png (one per document)

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 7, 2026

Test Build Preview

Generated from f08fbde

Artifacts

Download the generated files from the workflow run:

Single-file mode (test-output-single):

  • resume.pdf
  • index.html
  • preview.png

Combined mode (test-output-combined):

  • docs.pdf (combined)
  • index.html (auto-generated index)
  • docs/*.html (individual pages)
  • preview.png

Collection mode - flat (test-output-collection-flat):

  • resume.pdf, cover-letter.pdf, references.pdf
  • resume.html, cover-letter.html, references.html
  • *-preview.png (one per document)

Collection mode - nested (test-output-collection-nested):

  • projects/web/.pdf, projects/mobile/.pdf
  • projects/web/.html, projects/mobile/.html
  • *-preview.png (one per document)

@alDuncanson alDuncanson merged commit 372d336 into main Jan 7, 2026
5 checks passed
@alDuncanson alDuncanson deleted the multi-file-support branch January 7, 2026 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant