GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → timvink → mkdocs-print-site-plugin

timvink / mkdocs-print-site-plugin

Licence: MIT License
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.

Programming Languages

python
139335 projects - #7 most used programming language
CSS
56736 projects
javascript
184084 projects - #8 most used programming language
Smarty
1635 projects

Labels

pdfmkdocsprintpdfsmkdocs-plugin

Projects that are alternatives of or similar to mkdocs-print-site-plugin

mkdocs-markdownextradata-plugin
A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
Stars: ✭ 48 (+26.32%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-htmlproofer-plugin
A MkDocs plugin that validates URL in rendered html files
Stars: ✭ 17 (-55.26%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-section-index
MkDocs plugin to allow clickable sections that lead to an index page
Stars: ✭ 36 (-5.26%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-static-i18n
MkDocs i18n plugin using static translation markdown files
Stars: ✭ 78 (+105.26%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-git-authors-plugin
MkDocs plugin to display git authors of a page.
Stars: ✭ 27 (-28.95%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-rss-plugin
MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta).
Stars: ✭ 43 (+13.16%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-literate-nav
MkDocs plugin to specify the navigation in Markdown instead of YAML
Stars: ✭ 19 (-50%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-table-reader-plugin
MkDocs plugin that adds a {{ read_csv('table.csv') }} markdown tag to directly insert CSV files as a table into a page.
Stars: ✭ 60 (+57.89%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-git-revision-date-localized-plugin
MkDocs plugin to add a last updated date to your site pages
Stars: ✭ 73 (+92.11%)
Mutual labels:  mkdocs, mkdocs-plugin
mkdocs-exclude-search
🔎 A mkdocs plugin that lets you exclude selected chapters from the search index.
Stars: ✭ 16 (-57.89%)
Mutual labels:  mkdocs, mkdocs-plugin
thegreatmarkdown
《了不起的 Markdown》
Stars: ✭ 44 (+15.79%)
Mutual labels:  mkdocs
ipp.rs
IPP protocol implementation for Rust
Stars: ✭ 24 (-36.84%)
Mutual labels:  print
doxybook2
Doxygen XML to Markdown (or JSON)
Stars: ✭ 140 (+268.42%)
Mutual labels:  mkdocs
booklet
The definitive OwnTracks documentation
Stars: ✭ 26 (-31.58%)
Mutual labels:  mkdocs
print
Android print app
Stars: ✭ 18 (-52.63%)
Mutual labels:  print
mkdocs build plantuml
MkDocs plugin to help generate your plantuml images locally or remotely as files (NOT inline)
Stars: ✭ 31 (-18.42%)
Mutual labels:  mkdocs
cheatsheets
John's Cheatsheets
Stars: ✭ 22 (-42.11%)
Mutual labels:  mkdocs
mkdocs-rtl
mkdocs rtl theme based on mkdocs-material
Stars: ✭ 22 (-42.11%)
Mutual labels:  mkdocs
kotlin-rev-solution
Kotlin reference site in Japanese.
Stars: ✭ 46 (+21.05%)
Mutual labels:  mkdocs
docs-v1
Source of code.kx.com/q
Stars: ✭ 33 (-13.16%)
Mutual labels:  mkdocs
View All Similar Projects ➔

Actions Status PyPI - Python Version PyPI PyPI - Downloads codecov GitHub contributors PyPI - License

mkdocs-print-site-plugin

MkDocs plugin that adds a print page to your site that combines the entire site, allowing for easy export to PDF and standalone HTML. See demo.

Features 🌟

  • Support for mkdocs-material theme, including features like instant loading and dark color themes.
  • Support for pagination in PDFs.
  • Many options to customize appearance
  • Option to add a cover page
  • Lightweight, no dependencies.

Setup

Install the plugin using pip3:

pip3 install mkdocs-print-site-plugin

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - print-site

⚠️ Make sure to put print-site to the bottom of the plugin list. This is because other plugins might alter your site (like the navigation), and you want these changes included in the print page.

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set.

Usage

  • Navigate to /print_page/ or print_page.html
  • Export to standalone HTML (see export to HTML)
  • Export to PDF using your browser using File > Print > Save as PDF (see export to PDF)

Documentation

Available at timvink.github.io/mkdocs-print-site-plugin.

Contributing

Contributions are very welcome! Start by reading the contribution guidelines.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].