Skip to content

Commit

Permalink
chore: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
adrienbrignon committed Jun 7, 2024
1 parent d91df1d commit 58be8f9
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).

0 comments on commit 58be8f9

Please sign in to comment.