Releases: timvink/mkdocs-print-site-plugin
Releases · timvink/mkdocs-print-site-plugin
print-site-plugin v2.0.1
print-site-plugin v2.0.0
Major new release of print-site
with many bug fixes, improved exporting to standaline HTML and PDF, improved styling and updated documentation. This release does include a number of breaking changes. For a demo, see the print page of the documentation.
Breaking changes
add_to_navigation
now defaults tofalse
instead oftrue
(4fd5a39)add_print_site_banner
now defaults tofalse
instead oftrue
(5f121e9)toc_depth
now defaults to3
instead of6
(eb2fdc2)enumerate_headings
now defaults totrue
instead offalse
(9f204b8)enumerate_figures
now defaults totrue
instead offalse
(9f204b8)
Changed
- HTML print page now does not have the navigation sidebar or top navigation tabs (29660f2)
- The inline table of contents will now only be displayed on the print version of the print page. The HTML version has a new sidebar ToC. (436fbad)
- Improved styling of the cover page (b49b29b)
- The cover page is now also displayed on the HTML version of the print page (967d683)
- Prettier highlight animation when using sidebar ToC on print page to navigate around (967d683)
Added
- New table of contents sidebar for the HTML version of the print page, showing the page titles and with support for sections.
- Documentation on how to automate exporting to standalone HTML and PDF formats
Fixed
- Bug where setting
add_print_site_banner
would lead to 'no such file found' error (4e3a235) - Using navigation in the print page would lead to headings being hidden under the navbar (in mkdocs-material) (c8fad64)
- Bug where tab content would not display when a page contained multiple tabsets. (#53)
- Bug where we would validate pages on having level 1 headings, that were not part of the navigation (25bc443)
- Bug where section headings were closed with an incorrect tag (bcce1f2)
print-site-plugin v.1.3.0
Added
Fixed
- Error is now raised when any page in the website does not start with a heading level 1, when
add_table_of_contents: true
and/orenumerate_headings: true
. This used to silently mess up enumeration and the table of contents. (c4895ce)
print-site-plugin v.1.2.4
Fixed
- Table of contents generated too many times when using snippets extension, and/or mkdocs-material's instant loading feature (#49)
- Table of contents not generated and enumeration messed up due to heading content edge cases (#51)
print-site-plugin v.1.2.3
Changed
- Reverts: Raise error when pymdownx.details markdown extension is enabled in combination with mkdocs-material. This has now been fixed in
mkdocs-material==7.1.5
(see squidfunk/mkdocs-material#2655)
print-site-plugin v.1.2.2
Added
- Raise error when
pymdownx.details
markdown extension is enabled in combination withmkdocs-material
. This currently breaks print (see squidfunk/mkdocs-material#2655)
print-site-plugin v.1.2.1
Fixed
- Fixed error in table of contents where page key where inserted into headings (9a4bc78)
print-site-plugin v.1.2
print-site-plugin v.1.1
Added
- Option to disable print-site banner #38
- Option to template print-site banner #38
- Support for attachments (#42)
- Support for footnotes (#41)
- Option to change the title of the table of contents (#39)
- Option to reduce the depth of the table of contents (#39)
Fixed
- Fix anchors for relative links when
use_directory_urls
isfalse
(#30)
print-site v1.0.0
print-site 1.0.0
First major release!
Added
- Added option with documentation to ignore certain elements (see docs) #31
- Added option to exclude entire pages from print page #34
- Improved formatting of table of contents when using nested sections db114c0 (see #27)
- Added support for nested sections, including support for enumeration #27
- Added sections from navigation to print page content, including support for enumeration #27
- Clarified how to avoid print dialog for printing PDFs #33
- Clarified how to add images to the print cover page #28