Permalink
Browse files

Initial import based on mkdocs-material 1.10.2

  • Loading branch information...
jonas committed Oct 1, 2017
0 parents commit dc6bfa7104ac32c1856cb2720618cba11b4fb385
@@ -0,0 +1,2 @@
target
project/project
@@ -0,0 +1,17 @@
language: scala
jdk: oraclejdk8
scala: 2.10.6
script: sbt compile
cache:
directories:
- $HOME/.ivy2/cache
- $HOME/.sbt
before_cache:
- find $HOME/.ivy2/cache -name "ivydata-*.properties" -print -delete
- find $HOME/.sbt -name "*.lock" -print -delete
notifications:
email:
on_success: never
@@ -0,0 +1,23 @@
# Contributing
Bugs and feature requests should be reported in the [issue tracker] and answer
the following questions:
- Motivation: Why should this be addressed? What is the purpose?
- Input: What are the pre-conditions and actual behavior?
- Output: What is the expected outcome after the issue has been addressed?
- Test: How can the results listed in the "Output" be QA'ed?
For code contributions, these are the suggested steps:
- Identify the change you'd like to make, e.g. fix a bug or add a feature.
Before larger contributions please [first creating an issue][issue tracker]
to ensure that the change is properly scoped.
- Fork the repository on GitHub.
- Develop your change on a feature branch.
- Write tests to validate your change works as expected.
- Create a pull request.
- Address any issues raised during the code review.
- Once you get a "+1" on the pull request, the change can be merged.
[issue tracker]: https://github.com/jonas/paradox-material-theme/issues/new
20 LICENSE
@@ -0,0 +1,20 @@
Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
Copyright (c) 2017 Jonas Fonseca <jonas.fonseca@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
@@ -0,0 +1,41 @@
# 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-2017 Martin Donath
License: MIT
https://squidfunk.github.io/mkdocs-material/license/
Integration and adaptation for use with Paradox:
Copyright (c) 2017 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) and [Prettify] (Apache-2.0).
In addition the it loads the [Roboto font] (Apache-2.0), the [Material Icon font] (Apache-2.0),
as well as [FontAwesome] (SIL Open Font License) from various CDNs. All copyright
of their respective authors.
[Paradox]: https://github.com/lightbend/paradox
[Paradox Material Theme]: https://jonas.github.io/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/
108 build.sbt
@@ -0,0 +1,108 @@
name := "paradox-material-theme"
organization := "io.github.jonas"
licenses += "MIT" -> url("https://github.com/jonas/paradox-material-theme/blob/master/LICENSE")
enablePlugins(ParadoxThemePlugin, ParadoxPlugin)
paradoxTheme := None
sourceDirectories in (Compile, paradoxTheme) += sourceDirectory.value / "main" / "assets"
includeFilter in (Compile, paradoxTheme) := "*.st"
WebKeys.webJars in Assets := {
val out = (WebKeys.webJars in Assets).value
(WebKeys.webJarsDirectory in Assets).value.**(
"*.min.js" | "*.min.css" | "lang-*.js" | "prettify.css" | "prettify.js"
).get.filter(_.isFile)
}
libraryDependencies += "org.webjars" % "prettify" % "4-Mar-2013-1" % Provided
libraryDependencies += "org.webjars" % "modernizr" % "2.8.3" % Provided
libraryDependencies += Seq("animation", "base", "ripple", "rtl", "theme", "typography").foldLeft("org.webjars.npm" % "material__tabs" % "0.3.1" % Provided) {
(lib, dep) => lib.exclude("org.webjars.npm", s"material__$dep")
}
paradoxProperties in Compile ++= Map(
"project.name" -> "Paradox Material Theme",
"github.base_url" -> "https://github.com/jonas/paradox-material-theme"
)
//#color
paradoxProperties in Compile ++= Map(
"material.color.primary" -> "teal",
"material.color.accent" -> "indigo"
)
//#color
//#repository
paradoxProperties in Compile ++= Map(
"material.repo" -> "https://github.com/jonas/paradox-material-theme",
"material.repo.type" -> "github",
"material.repo.name" -> "jonas/paradox-material-theme"
)
//#repository
//#social
paradoxProperties in Compile ++= Map(
"material.social.github" -> "https://github.com/jonas",
"material.social.twitter" -> "https://twitter.com/priorarts"
)
//#social
//#analytics
paradoxProperties in Compile ++= Map(
"material.google.analytics" -> "UA-107934279-1" // Remember to change this!
)
//#analytics
//#copyright
paradoxProperties in Compile ++= Map(
"material.copyright" -> """
Based on <a href="https://github.com/squidfunk/mkdocs-material">MkDocs Material</a>
by <a href="https://github.com/squidfunk">Martin Donath</a>
"""
)
//#copyright
val optionExamples = Def.setting(
//#font
paradoxProperties in Compile ++= Map(
"material.font.text" -> "Ubuntu",
"material.font.code" -> "Ubuntu Mono"
)
//#font
,
//#font-disable
paradoxProperties in Compile ++= Map(
"material.font.disabled" -> "true" // NOTE: Any value will do
)
//#font-disable
,
//#favicon
paradoxProperties in Compile ++= Map(
"material.favicon" -> "assets/images/favicon.png"
)
//#favicon
,
//#logo
paradoxProperties in Compile ++= Map(
"material.logo" -> "assets/images/logo.png"
)
//#logo
,
//#logo-icon
paradoxProperties in Compile ++= Map(
"material.logo.icon" -> "cloud"
)
//#logo-icon
,
//#custom-stylesheet
paradoxProperties in Compile ++= Map(
"material.custom.stylesheet" -> "custom.css"
)
//#custom-stylesheet
,
//#custom-javascript
paradoxProperties in Compile ++= Map(
"material.custom.javascript" -> "assets/custom.js"
)
//#custom-javascript
)
@@ -0,0 +1 @@
sbt.version=1.0.2
@@ -0,0 +1,2 @@
addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.3.1")
addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-theme" % "0.3.1")
Binary file not shown.

Large diffs are not rendered by default.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit dc6bfa7

Please sign in to comment.