Permalink
Browse files

Add website (#228)

  • Loading branch information...
alexarchambault committed Oct 2, 2018
1 parent 38354fc commit c370d6a5c4b819f8820b5dd31144cf11e2a7cc75
View
@@ -1,3 +1,6 @@
target/
.DS_Store
.idea/
# website stuff
processed-pages/
View
@@ -11,11 +11,18 @@ before_install:
sudo: required
stages:
- name: test
- name: update-website
if: (branch = master AND type = push) OR (tag IS present)
- name: release
if: (branch = master AND type = push) OR (tag IS present)
jobs:
include:
- scala: 2.11.12
- scala: 2.12.6
- env: WEBSITE=1 # unused from the script, just to know what the job does from the Travis UI
script: scripts/update-website.sh
- stage: update-website
env: PUSH_WEBSITE=1
script: scripts/update-website.sh
- stage: release
script: sbt ci-release
View
@@ -2,50 +2,11 @@
*almond* is a [Scala](https://scala-lang.org) kernel for [Jupyter](https://jupyter.org).
It mostly wraps the [Ammonite](http://ammonite.io) Scala shell in a Jupyter kernel,
with the addition of custom Jupyter-specific APIs. It is formerly known as
*jupyter-scala*.
[![Build Status](https://travis-ci.org/jupyter-scala/jupyter-scala.svg?branch=develop)](https://travis-ci.org/jupyter-scala/jupyter-scala)
[![Join the chat at https://gitter.im/alexarchambault/jupyter-scala](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/alexarchambault/jupyter-scala?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Maven Central](https://img.shields.io/maven-central/v/sh.almond/kernel_2.12.svg)](https://maven-badges.herokuapp.com/maven-central/sh.almond/kernel_2.12)
It also provides libraries allowing one to write custom Jupyter kernels
in Scala.
See the project [website](https://almond-sh.github.io/almond/snapshot).
## Quick start
Create a launcher via [coursier](http://get-coursier.io) with
```
$ SCALA_VERSION=2.12.6 ALMOND_VERSION=0.1.7
$ coursier bootstrap \
-i user -I user:sh.almond:scala-kernel-api_$SCALA_VERSION:$ALMOND_VERSION \
sh.almond:scala-kernel_$SCALA_VERSION:$ALMOND_VERSION \
-o almond
```
See the available versions of almond [here](https://github.com/jupyter-scala/jupyter-scala/releases),
adjust `ALMOND_VERSION` and `SCALA_VERSION` at your convenience (not all combinations are guaranteed
to be available, see the available combinations [here](docs/versions.md)).
Run the launcher like
```
$ ./almond --install
```
to install the kernel. See `./almond --help` for the available options. Once the kernel is
installed, the generated launcher can then be safely removed, with `rm -f almond`.
## All-included launcher
The launcher above downloads the JARs it needs upon launch. These JARs are downloaded to /
picked from the cache of coursier. You may prefer to have the launcher embed all these JARs,
so that nothing needs to be downloaded or picked from a cache upon launch. Passing
`--standalone` to the `coursier bootstrap` command generates such a launcher,
```
$ SCALA_VERSION=2.12.6 ALMOND_VERSION=0.1.7
$ coursier bootstrap --standalone \
-i user -I user:sh.almond:scala-kernel-api_$SCALA_VERSION:$ALMOND_VERSION \
sh.almond:scala-kernel_$SCALA_VERSION:$ALMOND_VERSION \
-o almond
```
but that launcher won't work fine until something like https://github.com/lihaoyi/Ammonite/pull/850
is merged in Ammonite.
@@ -1,4 +1,6 @@
# Writing custom kernels
---
title: Writing custom kernels
---
The sources of the scala kernel have such an example demo kernel under [this directory](https://github.com/jupyter-scala/jupyter-scala/tree/c6bc94a397196be52232cc833e1095ef5e6264d2/modules/echo).
View
@@ -0,0 +1,24 @@
---
title: Install
---
Create a launcher via [coursier](http://get-coursier.io) with
```
$ SCALA_VERSION=@SCALA_VERSION@ ALMOND_VERSION=@VERSION@
$ coursier bootstrap @EXTRA_COURSIER_ARGS@\
-i user -I user:sh.almond:scala-kernel-api_$SCALA_VERSION:$ALMOND_VERSION \
sh.almond:scala-kernel_$SCALA_VERSION:$ALMOND_VERSION \
-o almond
```
See the available versions of almond [here](https://github.com/jupyter-scala/jupyter-scala/releases),
adjust `ALMOND_VERSION` and `SCALA_VERSION` at your convenience (not all combinations are guaranteed
to be available, see the available combinations [here](versions.md)).
Run the launcher like
```
$ ./almond --install
```
to install the kernel. See `./almond --help` for the available options. Once the kernel is
installed, the generated launcher can then be safely removed, with `rm -f almond`.
View
@@ -0,0 +1,18 @@
---
title: Intro
hide_title: true
---
# almond
*almond* is a [Scala](https://scala-lang.org) kernel for [Jupyter](https://jupyter.org).
It mostly wraps the [Ammonite](http://ammonite.io) Scala shell in a Jupyter kernel,
with the addition of custom Jupyter-specific APIs. It is formerly known as
*jupyter-scala*.
It also provides libraries allowing one to write custom Jupyter kernels
in Scala.
*This is the documentation for version @VERSION@*.
View
@@ -0,0 +1,20 @@
---
title: Other
---
## All-included launcher
The launcher above downloads the JARs it needs upon launch. These JARs are downloaded to /
picked from the cache of coursier. You may prefer to have the launcher embed all these JARs,
so that nothing needs to be downloaded or picked from a cache upon launch. Passing
`--standalone` to the `coursier bootstrap` command generates such a launcher,
```
$ SCALA_VERSION=2.12.6 ALMOND_VERSION=0.1.7
$ coursier bootstrap --standalone \
-i user -I user:sh.almond:scala-kernel-api_$SCALA_VERSION:$ALMOND_VERSION \
sh.almond:scala-kernel_$SCALA_VERSION:$ALMOND_VERSION \
-o almond
```
but that launcher won't work fine until something like https://github.com/lihaoyi/Ammonite/pull/850
is merged in Ammonite.
@@ -1,3 +1,7 @@
---
title: Versions
---
Available Scala versions for each version of almond
Almond version | Scala 2.11 version | Scala 2.12 version
View
@@ -0,0 +1,7 @@
node_modules/
translated_docs
build/
yarn.lock
node_modules
i18n/*
@@ -0,0 +1,66 @@
/**
* Copyright (c) 2017-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
const React = require('react');
class Footer extends React.Component {
docUrl(doc, language) {
const baseUrl = this.props.config.baseUrl;
return `${baseUrl}docs/${language ? `${language}/` : ''}${doc}`;
}
pageUrl(doc, language) {
const baseUrl = this.props.config.baseUrl;
return baseUrl + (language ? `${language}/` : '') + doc;
}
render() {
return (
<footer className="nav-footer" id="footer">
<section className="sitemap">
<a href={this.props.config.baseUrl} className="nav-home">
{this.props.config.footerIcon && (
<img
src={this.props.config.baseUrl + this.props.config.footerIcon}
alt={this.props.config.title}
width="66"
height="58"
/>
)}
</a>
<div>
<h5>Docs</h5>
<a href={this.docUrl('intro.html')}>
Quick start
</a>
</div>
<div>
<h5>Community</h5>
<a href="https://gitter.im/alexarchambault/jupyter-scala">Gitter room</a>
</div>
<div>
<h5>More</h5>
<a href="https://github.com/almond-sh/almond">GitHub</a>
<a
className="github-button"
href={this.props.config.repoUrl}
data-icon="octicon-star"
data-count-href="/almond-sh/almond/stargazers"
data-show-count="true"
data-count-aria-label="# stargazers on GitHub"
aria-label="Star this project on GitHub">
Star
</a>
</div>
</section>
<section className="copyright">{this.props.config.copyright}</section>
</footer>
);
}
}
module.exports = Footer;
Oops, something went wrong.

0 comments on commit c370d6a

Please sign in to comment.