Material Design theme for Paradox
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
plugin/src
project
src/main/paradox
theme/src/main/assets
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
NEWS.md
README.md
build.sbt
publish.sbt

README.md

Paradox Material Theme

A Material Design theme for Paradox, a static site generator geared towards project documentation. It is based on the excellent MkDocs Material, which is built using Google's Material Design guidelines.

Paradox Material Theme

See the documentation for how to start using the theme.

Licenses and copyrights

Many thanks to Martin Donath for creating the MkDocs Material theme on which this project is based. This goes for the stylesheet and javascript artifacts, the HTML templates as well as the great documentation:

Copyright (c) 2016-2018 Martin Donath
License: MIT
https://squidfunk.github.io/mkdocs-material/license/

Integration and adaptation for use with Paradox:

Copyright (c) 2017-2018 Jonas Fonseca
License: MIT

The theme also uses the tabs component from Material Components for the web (Apache-2.0), Modernizr (available under BSD/MIT licenses), Prettify (Apache-2.0), Material Icon font (Apache-2.0), and FontAwesome (SIL Open Font License). Optionally, it can load fonts, like the Roboto font (Apache-2.0), from Google's font CDN. All copyright of their respective authors.