dotnet / docfx

Static site generator for .NET API documentation.
https://dotnet.github.io/docfx/
MIT License
4.05k stars 861 forks source link

PDF Generation #10267

Open frohlichcortezh opened 1 day ago

frohlichcortezh commented 1 day ago

Describe the bug PDF generate isn't located where I believe it'd be after following the documentation.

I might have misunderstood something, so I hope somebody could help.

To Reproduce

Here's my docfx.json
{
  "metadata": [
    {
      "src": [
        {
          "files": ["**/*.csproj"],
          "exclude": ["**/bin/**", "**/obj/**"],
          "src": "../"
        }
      ],
      "dest": "api"
    }
  ],
  "pdf": {
    "content": [
      {
        "files": [
          "articles/**.yml"
        ],
        "exclude": [
          "api/**",
          "**/bin/**",
          "**/obj/**",
          "_site_pdf/**",
          "**/toc.yml",
          "**/toc.md"
        ]
      }
    ],
    "resource": [
      {
        "files": [ "articles/images/**"]
      }
    ],
    "overwrite": "specs/*.md",
    "dest": "_site-pdf"
  },
  "build": {
    "content": [
      {
        "files": [
          "index.md",
          "articles/**/*.md",
          "articles/**/*.yml"
        ],
        "exclude": [
          "_site/**",
          "**.*.pdf"
        ]
      },
      {
        "files": [
          "api/**/*.md",
          "api/**/*.yml"
        ]
      }
    ],
    "resource": [
      {
        "files": [
          "articles/images/**"
        ]
      }
    ],
    "output": "_site",
    "template": [
      "default",
      "modern"
    ],
    "globalMetadata": {
      "_appName": "BKS.Gmud",
      "_appTitle": "Gmud",
      "_enableSearch": true,
      "homepage": "index.md",
      "pdf": true,
      "pdfTocPage": true,
      "pdfFileName": "Manual-GMUD.pdf"
    },
    "postProcessors": ["ExtractSearchIndex"]
  }
}

Expected behavior After running docfx pdf````, I though a folder_site-pdf```` would have been generated.

Screenshots

Image

It was generated under _site/articles/ Image

Context (please complete the following information):

filzrev commented 1 day ago

I though a folder `_site-pdf`` would have been generated.

pdf config sections are not supported on latest version (v2.77.0). (These config section is used before v2.75.0 that using wkhtmltopdf to generate PDFs)

frohlichcortezh commented 1 day ago

I though a folder `_site-pdf`` would have been generated.

pdf config sections are not supported on latest version (v2.77.0). (These config section is used before v2.75.0 that using wkhtmltopdf to generate PDFs)

Thank you for the quick reply. Do you suggest downgrading ? Any tips on how I could set it up on v2.77 ?

filzrev commented 23 hours ago

Currently no options available for generating PDFs and outputs PDF files only. It though, it need to manually copy PDF files from _site output directories.