Skip to content

Commit

Permalink
chore: improved README.md, included example
Browse files Browse the repository at this point in the history
  • Loading branch information
adrienbrignon committed May 8, 2023
1 parent f10791a commit b2c1831
Show file tree
Hide file tree
Showing 2 changed files 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 @@ -31,8 +31,8 @@ pip install mkdocs-exporter

Three plugins are currently available:

- `mkdocs/exporter` (*required*): base plugin that must precedes the others
- `mkdocs/exporter/pdf` (*optional*): the plugin that exports your pages as individual PDF documents
- `mkdocs/exporter` (*required*): base plugin which must precede the others
- `mkdocs/exporter/pdf` (*optional*): plugin that exports your pages as individual PDF documents
- `mkdocs/exporter/extras` (*optional*): provides extra functionalities (buttons, HTML utilities...)

### Example
Expand All @@ -57,12 +57,17 @@ plugins:
download: !!python/name:mkdocs_exporter.plugins.pdf.button.download
```
Check out a [sample PDF generated by this plugin](examples/example.pdf) from the default page of the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) theme.
It has been built with some custom CSS and features cover pages.
## Roadmap
- Documentation (based on `MkDocs` and featuring this plugin)
- Ensure full compatibility with other themes than `mkdocs-material`
- Combine all pages as one PDF

Feel free to request additional features by submitting an issue or by contributing through a pull request.

## License

This project is licensed under the `MIT License (MIT)`, which you can read [here](LICENSE.md).
Binary file added examples/example.pdf
Binary file not shown.

0 comments on commit b2c1831

Please sign in to comment.