From 58be8f9e12c28e6a00e759cc7921d7f2e50a7804 Mon Sep 17 00:00:00 2001 From: Adrien Brignon Date: Fri, 7 Jun 2024 23:09:05 +0200 Subject: [PATCH] chore: updated README --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac483a3..6e8ca42 100644 --- a/README.md +++ b/README.md @@ -28,12 +28,12 @@ Additionally, it can combine your entire documentation into a single PDF file. ## Features -- 🚀 **Fast** - PDF documents are generated concurrently! +- 🚀 **Fast** - All PDF documents are generated concurrently! - 🎨 **Customizable** - full control over the resulting documents + - Combine all your pages into a single PDF document - Create [cover pages](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-documents/#setting-up-cover-pages) - Define custom scripts and stylesheets to customize your PDF documents - Add [buttons](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-buttons/) to the top of your pages ([example](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-buttons/)) - - Combine all your pages into a single PDF document - Compatible with [`material`](https://github.com/squidfunk/mkdocs-material) and [`readthedocs`](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) themes - Check out sample PDF documents [here](./examples/themes) - ⭐ **Powerful** - it uses a headless browser and some awesome libraries under the hood to generate PDF documents @@ -85,6 +85,11 @@ Check out a [sample PDF generated by this plugin](examples/example.pdf), it incl Feel free to request additional features by submitting an issue or contributing through a pull request. +## Contributing + +We welcome contributions from the community to enhance MkDocs Exporter. +Whether you want to report a bug, suggest a feature, improve the documentation, or contribute code, your help is appreciated! + ## License This project is licensed under the `MIT License (MIT)`, which you can read [here](LICENSE).