Package: mkpdfs2-mkdocs
MkPDFs v2 for MkDocs:bangbang: This is a fork of original comwes/mkpdfs-mkdocs-plugin:exclamation: There could be many things that are not up-to-date, but at this moment (20.09.2023) this plugin should work.It's a MkDocs plugin that export your documentation in a single PDF file[][mkpdfsdoc]The MkPDFs plugin will export yor documentation in your MkDocs repository as a PDF file usingWeasyPrint.Unlike other plugin where customizing the design of the generated PDF is complicated, this plugin brings the ability to completely control the design of the generated PDF.What makes this plugin particular, is that:Your documentation is exported as a single PDF fileThe order of pages fits the navigation as defined in the MkDocs configuration fileThe ability to override the default design to make it fit your needsThe ability to exclude some files from the generated PDFNo layout issuesNo conflict with the theme designTable of contents integrated in the PDFRequirementsThis package requires MkDocs version 1.0Python 3.4 or higherWeasyPrint depends on cairo, Pango and GDK-PixBuf which need to be installed separately. Please follow your platform installation instructions carefully:LinuxMacOSWindowsLimitationThe PDF version of the documentation will not be created if the used generated page content's is not enclosed in an<article>tag  or in a<div>tag with propertyrole="main".InstallationInstall the package withpip:pip3installmkpdfs2-mkdocsEnable the plugin in yourmkdocs.ymlas folowingplugins:-search-mkpdfsor with optionsplugins:-search-mkpdfs:-company:The War Company Inc.-author:Monsieur SilvestreNote:If you enable this plugin and you don't havepluginsentry in your MkDocs config file yet, you will need to explicitly enable thesearchplugin. This plugin is enabled by default when nopluginsentry is set.You can find further information about plugins in theMkDocs documentation.How does it work?When building or serving your documentation withmkdocs buildormkdocs serve, the following message will be displayed if everything wend smoothly:The PDF version of the documentation has been generated.OptionsThis plugin supports following options to allow you better handle the customisation of the generated PDF.OptionDescriptionauthorThe author of the document. This information will be printed on the cover page of the generated PDF.companyIf this documentation is from a company, then you should provide this information. It will be displayed on the front page of the documentation, bellow the author informationtoc_titleThe table of content title. The default value isTable of Contentstoc_positionThe position of the table of contents. This option supports 3 differents values:preto put the toc at the beginning of the file but after the cover (the default value),postto put it at the end of the file ornoneto not generate it at all.output_pathThe file name of the generated PDF, relative to thesite_dir. By default this location is set topdf/combined.pdfpdf_linksCreate link to download the generated PDF to the top of each HTML page. By default this is enableddesignRelative to yourMkDocs repository, this option is the location of the CSS file defining the layout of the generated PDF. If this option is not defined the default design will be used. Defining an non existing file will cause the build or serve failure.generate_htmlSave the html from which the PDF is generated to be able to debug it in the browser. Default is FalseContributingFrom reporting a bug to submitting a pull request, every contribution is appreciated and welcome. Report bugs, ask questions and request features usingGithub issues.Thanks toThe idea of this plugin has raised while working on a project in the public sector. After many research I found some plugins that guided me to the current solution. They have inspired me a lot, so many thanks to:Terry Zhaothe author of theMkDocs PDF Export Pluginthe source of our inspiration. We've used some of his code in this project.Kozea teamfor bringingWeasyPrintto us as an open source project. The default design of the generated PDF is based on their workreport Sample.Martin Donaththe author ofMaterial for MkDocs, some of his css file were used to design the layout of Admonition, Codehilite, Arthmatex, emoji, and more.[Gerry Ntabuhashe][comwes] the author of the original mkpdfs plugin.