https://github.com/sbt/sbt-paradox-material-theme

Material Design theme for Paradox
https://github.com/sbt/sbt-paradox-material-theme

material-design paradox theme

Last synced: about 1 month ago
JSON representation

Material Design theme for Paradox

• Host: GitHub
• URL: https://github.com/sbt/sbt-paradox-material-theme
• Owner: sbt
• License: mit
• Created: 2017-10-09T22:23:10.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T07:55:22.000Z (2 months ago)
• Last Synced: 2024-12-02T08:39:29.830Z (2 months ago)
• Topics: material-design, paradox, theme
• Language: StringTemplate
• Homepage: https://www.scala-sbt.org/sbt-paradox-material-theme
• Size: 2.1 MB
• Stars: 53
• Watchers: 10
• Forks: 35
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](src/main/paradox/images/material.png)][Paradox Material Theme]

See the [documentation][Paradox Material Theme] 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.

 [Paradox]: https://github.com/lightbend/paradox

 [Paradox Material Theme]: https://sbt.github.io/sbt-paradox-material-theme/

 [MkDocs Material]: https://github.com/squidfunk/mkdocs-material

 [Material Design]: https://material.io/guidelines/material-design/

 [FontAwesome]: http://fontawesome.io/

 [Modernizr]: https://www.modernizr.com

 [Prettify]: https://github.com/google/code-prettify

 [Roboto font]: https://github.com/google/roboto

 [Material Icon font]: https://github.com/google/material-design-icons

 [Material Components for the web]: https://github.com/material-components/material-components-web/