{"id":13593743,"url":"https://github.com/timvink/mkdocs-print-site-plugin","last_synced_at":"2025-05-15T16:05:52.764Z","repository":{"id":39750577,"uuid":"287738481","full_name":"timvink/mkdocs-print-site-plugin","owner":"timvink","description":"MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.","archived":false,"fork":false,"pushed_at":"2025-05-07T07:30:09.000Z","size":2381,"stargazers_count":162,"open_issues_count":8,"forks_count":25,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-07T07:49:05.240Z","etag":null,"topics":["mkdocs","mkdocs-plugin","pdf","pdfs","print"],"latest_commit_sha":null,"homepage":"https://timvink.github.io/mkdocs-print-site-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timvink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["timvink"]}},"created_at":"2020-08-15T12:02:33.000Z","updated_at":"2025-05-07T07:30:05.000Z","dependencies_parsed_at":"2023-01-24T17:01:12.781Z","dependency_job_id":"cbb9ace9-702b-47f4-9a4b-f2ee925e5e31","html_url":"https://github.com/timvink/mkdocs-print-site-plugin","commit_stats":{"total_commits":244,"total_committers":11,"mean_commits":"22.181818181818183","dds":"0.049180327868852514","last_synced_commit":"c64dc03aeee8e9ce0359247a40ed9ea2c1d8cfdd"},"previous_names":[],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-print-site-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-print-site-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-print-site-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-print-site-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timvink","download_url":"https://codeload.github.com/timvink/mkdocs-print-site-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254374427,"owners_count":22060611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-plugin","pdf","pdfs","print"],"created_at":"2024-08-01T16:01:23.969Z","updated_at":"2025-05-15T16:05:52.742Z","avatar_url":"https://github.com/timvink.png","language":"Python","funding_links":["https://github.com/sponsors/timvink"],"categories":["Python","Documentation"],"sub_categories":[],"readme":"[![Actions Status](https://github.com/timvink/mkdocs-print-site-plugin/workflows/pytest/badge.svg)](https://github.com/timvink/mkdocs-print-site-plugin/actions)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-print-site-plugin)\n![PyPI](https://img.shields.io/pypi/v/mkdocs-print-site-plugin)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-print-site-plugin)\n[![codecov](https://codecov.io/gh/timvink/mkdocs-print-site-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/timvink/mkdocs-print-site-plugin)\n![GitHub contributors](https://img.shields.io/github/contributors/timvink/mkdocs-print-site-plugin)\n![PyPI - License](https://img.shields.io/pypi/l/mkdocs-print-site-plugin)\n\n# mkdocs-print-site-plugin\n\n[MkDocs](https://www.mkdocs.org/) 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](https://timvink.github.io/mkdocs-print-site-plugin/print_page.html).\n\n## Features :star2:\n\n- Support for [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme, including features like instant loading, dark color themes and certain plugins (f.e. the [tags](https://squidfunk.github.io/mkdocs-material/plugins/tags/) plugin)\n- Support for [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme\n- Support for pagination in PDFs.\n- Many options to customize appearance\n- Option to add a cover page\n- Lightweight, no dependencies.\n\n## Setup\n\nInstall the plugin using `pip3`:\n\n```bash\npip3 install mkdocs-print-site-plugin\n```\n\nNext, add the following lines to your `mkdocs.yml`:\n\n```yml\nplugins:\n  - search\n  - print-site\n```\n\n\u003e ⚠️ 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.\n\n\u003e 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.\n\n## Usage\n\n- Navigate to `/print_page/` or `print_page.html`\n- Export to standalone HTML (see [export to HTML](https://timvink.github.io/mkdocs-print-site-plugin/how-to/export-HTML.html))\n- Export to PDF using your browser using *File \u003e Print \u003e Save as PDF*  (see [export to PDF](https://timvink.github.io/mkdocs-print-site-plugin/how-to/export-PDF.html))\n\n## Documentation\n\nAvailable at [timvink.github.io/mkdocs-print-site-plugin](https://timvink.github.io/mkdocs-print-site-plugin/).\n\n## Contributing\n\nContributions are very welcome! Start by reading the [contribution guidelines](https://timvink.github.io/mkdocs-print-site-plugin/contributing.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-print-site-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimvink%2Fmkdocs-print-site-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-print-site-plugin/lists"}