Skip to content

feat: Integration PdfBuilder into docfx#9349

Merged
yufeih merged 8 commits into
mainfrom
pdfcmd
Oct 28, 2023
Merged

feat: Integration PdfBuilder into docfx#9349
yufeih merged 8 commits into
mainfrom
pdfcmd

Conversation

@yufeih
Copy link
Copy Markdown
Contributor

@yufeih yufeih commented Oct 27, 2023

To enable PDF, several new properties are introduced to toc.yml:

  • pdf: bool = false: determines if PDF should be generated for this TOC file
  • pdfFileName: string = "toc.pdf": customize the PDF file name. By default, it generates a toc.pdf side by side toc.json in output directory.

These options can also be configured in docfx.json through globalMetadata or fileMetadata to customize PDF options for generated TOCs, such as API reference TOCs.

Run docfx pdf command to generate PDF files. You don't need a pdf config section to use the new TOC based PDF support.
Run the docfx command to build the documents then generate pdf files.

#9343

@yufeih yufeih added the new-feature Makes the pull request to appear in "New Features" section of the next release note label Oct 27, 2023
@yufeih yufeih force-pushed the pdfcmd branch 3 times, most recently from b83ca0e to d4fe06b Compare October 27, 2023 15:13
@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 28, 2023

Codecov Report

Attention: 75 lines in your changes are missing coverage. Please review.

Files Coverage Δ
src/Docfx.App/Config/BuildJsonConfig.cs 100.00% <ø> (ø)
src/Docfx.App/RunBuild.cs 54.54% <ø> (ø)
src/docfx/Models/CommandHelper.cs 45.45% <ø> (+2.59%) ⬆️
src/Docfx.App/Config/DocfxConfig.cs 75.00% <75.00%> (ø)
src/docfx/Models/BuildCommand.cs 13.72% <0.00%> (+0.26%) ⬆️
src/docfx/Models/DefaultCommand.cs 82.35% <72.72%> (-0.51%) ⬇️
src/docfx/Models/MetadataCommand.cs 0.00% <0.00%> (ø)
src/docfx/Models/MergeCommand.cs 0.00% <0.00%> (ø)
src/Docfx.App/RunServe.cs 0.00% <0.00%> (ø)
src/docfx/Models/PdfCommand.cs 0.00% <0.00%> (ø)
... and 2 more

... and 1 file with indirect coverage changes

📢 Thoughts on this report? Let us know!.

@yufeih yufeih closed this Oct 28, 2023
@yufeih yufeih reopened this Oct 28, 2023
@yufeih yufeih merged commit 6b04165 into main Oct 28, 2023
@yufeih yufeih deleted the pdfcmd branch October 28, 2023 04:08
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-feature Makes the pull request to appear in "New Features" section of the next release note

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant