Skip to content

Configure DocFX to generate PDF with documentation #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
konard wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Configure DocFX to generate PDF with documentation #134

konard wants to merge 3 commits into from

Conversation

@konard
Copy link
Member

@konard konard commented Sep 10, 2025 •
edited
Loading

Summary

  • Configured DocFX to generate PDF documentation alongside HTML docs
  • Added pdf: true configuration to enable PDF generation in the documentation site
  • Updated CI workflow to use modern DocFX (v2.78.3) with built-in PDF support
  • Created custom publishing script to handle PDF files deployment

Key Changes

  • docfx.json: Added PDF configuration section with cover page and TOC support
  • toc.yml: Enabled PDF generation at the TOC level with pdf: true
  • publish-docs-with-pdf.sh: Custom script to deploy both HTML and PDF docs
  • csharp.yml: Updated workflow to use modern DocFX and generate PDFs

Test Plan

  • Validate JSON and YAML configuration syntax
  • Verify PDF generation works in CI pipeline
  • Check that PDF download button appears on documentation site
  • Confirm PDF contains complete documentation with cover page and TOC

Technical Details

The solution uses DocFX's built-in PDF generation capability (available in v2.73+) rather than external tools. This provides native PDF formatting with proper cross-references and table of contents.

🤖 Generated with Claude Code

Resolves #24

@konard
Initial commit with task details for issue #24
b9390f5 
Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #24
@konard konard self-assigned this Sep 10, 2025
konard and others added 2 commits September 10, 2025 18:45
@konard
Remove CLAUDE.md - PR created successfully
18d8c7a
@konard @claude
Configure DocFX to generate PDF with documentation
4cd30aa 
- Add docfx.json with PDF generation support
- Update toc.yml to enable PDF generation
- Create custom publish script for PDF documentation
- Update CI workflow to use modern DocFX with PDF capabilities
- Enable PDF download button in documentation site

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@konard konard changed the title [WIP] Configure DocFX to generate PDF with documentation. Configure DocFX to generate PDF with documentation Sep 10, 2025
@konard konard marked this pull request as ready for review September 10, 2025 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@konard konard

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Configure DocFX to generate PDF with documentation.

2 participants

@konard