Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Kazari design improvements #139

Merged
merged 4 commits into from
Feb 16, 2017
Merged

Kazari design improvements #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0375d45
Implemented design changes in DOM and CSS - Removing kazariStyle SBT …
Feb 15, 2017
cebf98d
Applying highlight theme color to kazari buttons
Feb 15, 2017
6855a99
Better adjustment of the button bar colors and modal window based on …
Feb 15, 2017
ceed7d1
Improved color selection from highlight.js color scheme
Feb 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions KAZARI_README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,19 @@ Once you have added these CSS classes to your code, just build your microsite as

`sbt-microsites` includes sbt settings to configure Kazari to suit your needs. Here's a list of those settings:

* **micrositeKazariStyle**: sets the name of the stylesheet file that provides the color scheme to Kazari. (Default: kazari-style-dark")
* **micrositeKazariEvaluatorUrl**: URL of the remote Scala Evaluator to be used by Kazari. Defaults to the [remote evaluator](https://github.com/scala-exercises/evaluator) used in [Scala Exercises](https://github.com/scala-exercises/scala-exercises).
* **micrositeKazariEvaluatorToken**: remote Scala Evaluator token to be used by Kazari. Check out the [README of the evaluator](https://github.com/scala-exercises/evaluator) for information on how to generate it.
* **micrositeKazariGithubToken**: optional GitHub token to be used by Kazari. Required for Kazari to perform certain actions (i.e. save Gists), which are still experimental.
* **micrositeKazariCodeMirrorTheme**: optional CodeMirror theme to be used by Kazari in its modal editor.
* **micrositeKazariDependencies**: optional list of dependencies needed to compile the code to be evaluated by Kazari (set of groupId, artifactId, and versionId).
* **micrositeKazariResolvers**: optional list of resolver urls needed for the provided dependencies to be fetched by Kazari.

Kazari will try to match its color scheme to the Microsite's highlight color theme. If the default colors don't quite match or you want to change them, we provide a few class for you to customize:

* **compiler-kazari-background**: background color of the button bar.
* **compiler-kazari-border**: foreground color of the button borders.
* **compiler-kazari-color**: foreground color of the button texts and icons.

# Using Kazari without sbt-microsites

Kazari comes integrated with `sbt-microsites` (and in fact is a part of the project), but you don't need to create your site with the plugin in order to use it.
Expand All @@ -46,7 +51,7 @@ Once you get all your scripts and stylesheets ready, you just need to include th
<body>

<script type="text/javascript" src="kazari.js"></script>
<link rel="stylesheet" href="style-dark.css">
<link rel="stylesheet" href="kazari-style.css">
<link rel="stylesheet" href="codemirror.css">
<link rel="stylesheet" href="monokai.css">

Expand Down
2 changes: 1 addition & 1 deletion build.sbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ lazy val jsSettings = Seq(
jsDependencies ++= Seq(
"org.webjars" % "jquery" % "2.1.3" / "2.1.3/jquery.js",
ProvidedJS / "codemirror.js",
ProvidedJS / "javascript.js" dependsOn "codemirror.js"
ProvidedJS / "clike.js" dependsOn "codemirror.js"
)
)

Expand Down
Loading