docascode/docfx-feature-proposals

Missing PDF functions in docFX and a few suggestions from current projects.

Xarkam asked for this feature about 3 years ago — 1 comment

Xarkam commented about 3 years ago

Based on issue https://github.com/dotnet/docfx/issues/1882

The possibilities available so far in doxFX with regard to the PDF generation are, unfortunately, very lean. For the PDF generation to be useful, the following features should be added in any case:

  1. Logo in header other than first page This should be possible with the help of a PDF background template. Then you could easily combine the documentation with the rest. To do this, simply set the background template in the background of the generated PDFs. This can be done with iTextSharp very simply, and without much effort.

  2. Side numbering at the bottom right or left or centered Should be done, if possible, per area (toc), or for the whole document.

  3. Document title in footer left / center or right Possibly also with a PDF background template solvable. Should always be in the same place.

  4. Page margins: top, bottom, left, right freely definable This is very important if the user wants to print the document. The margins, which have been standard so far, are simply too narrow.

  5. Download link on the homepage, or any underside of the online documentation (cross-reference to the generated PDFs within other templates) This would be very cool, if one could refer directly to the generated PDF documentation. Thus, one would not have to merge the documentations in the following, and still adapt manually.

  6. Table of contents with page numbers. The links in the table of contents are clickable, but when you print the generated document, navigation is not really easy.

  7. Merge the articles into a large one An extra page has been created per markdown file. However, not all articles are a whole page long. This means that there may be a lot of void space. Especially when printing, this can be very annoying, because too much paper is consumed. Would here possibly a merge of the Markdown files to a large conceivable?

Join the discussion!

Sign-in with GitHub to comment