The Scala Documentation website
JavaScript HTML CSS Ruby Shell
Latest commit 83b2189 Oct 21, 2016 @heathermiller heathermiller committed on GitHub Merge pull request #609 from jarrodwb/scaladoc-warning
fix liquid markup in scaladoc tutorial
Failed to load latest commit information.
.bundle update using bundle update Oct 18, 2016
_data Added Bosnian translations for tour and cheatsheet Aug 27, 2016
_includes Go back to `Not Accepted` and capitalize it Sep 26, 2016
_layouts Fix HTML redirects on scaladoc pages Aug 1, 2016
ba Fix duplicate words Sep 16, 2016
cheatsheets Added Bosnian translations for tour and cheatsheet Aug 27, 2016
de/tutorials tour: polymorphic methods Jun 13, 2012
es fixed a bunch of dead links Sep 22, 2016
fr/cheatsheets replace h2 tag by span tag like english version. Jul 17, 2014
glossary Merge pull request #286 from Debilski/quote-fix Jul 13, 2015
it/tutorials fix up it/tutorials/ Apr 1, 2016
ja Merge pull request #488 from petergram/futures-andthen-syntax Oct 17, 2016
ko/tutorials Fix typos Aug 1, 2016
news/_posts I hate jekyll Jun 30, 2013
overviews fix liquid markup in scaladoc tutorial Oct 21, 2016
pt-br/cheatsheets revert addition of Brazilian collections overview Aug 24, 2015
resources Add status to pending posts and modify css Sep 26, 2016
scripts fix up implicit conversions and make errors more verbose Oct 21, 2016
sips Merge pull request #488 from petergram/futures-andthen-syntax Oct 17, 2016
style shorten long name to fit into the provided space Sep 19, 2016
tutorials remove extra import Oct 21, 2016
zh-cn/overviews Merge pull request #488 from petergram/futures-andthen-syntax Oct 17, 2016
zh-tw/tutorials Add space between Chinese and English Aug 12, 2016
.gitignore Merge pull request #466 from SethTisue/views-usually-means-collection… Dec 8, 2015
.travis.yml Revert .travis.yml back to sudo: false w/ workaround Oct 7, 2016
CNAME Adding CNAME for domain redirect for Oct 26, 2011
Gemfile update Gemfile to reflect current usage. Oct 6, 2016
Gemfile.lock update using bundle update Oct 18, 2016 Upgraded project docs to include -I incremental switch Oct 19, 2016
_config.yml get tut to work with Travis Oct 3, 2016
conduct.html Code of Conduct is on main Scala site now Dec 18, 2015 Merge pull request #594 from SethTisue/point-of-contact Oct 17, 2016 Progress on front page, and navigation. Oct 19, 2011
search.html More hacks to fix issues caused by the need for a sticky footer. This… Oct 31, 2011

Scala Documentation

This repository contains the source for the Scala documentation website, as well as the source for "Scala Improvement Process" (SIP) documents.


Please have a look at before making a contribution. This document gives an overview of the type of documentation contained within the Scala Documentation repository and the repository's structure.

Small changes, or corrected typos will generally be pulled in right away. Large changes, like the addition of new documents, or the rewriting of existing documents will be thoroughly reviewed-- please keep in mind that, generally, new documents must be very well-polished, complete, and maintained in order to be accepted.


This site uses a Jekyll, a Ruby framework. You'll need Ruby and Bundler installed; see Jekyll installation instructions for the details.

Building & Viewing

cd into the directory where you cloned this repository, then install the required gems with bundle install. This will automatically put the gems into ./vendor/bundle.

Start the server in the context of the bundle (use -I for incremental builds):

bundle exec jekyll serve -I

It might take around 5 minutes at first but incremental compilations will be fast.

The generated site is available at http://localhost:4000

If you add --watch at the end of the command line above, Jekyll will automatically watch for changes on the filesystem, and regenerate the site.

If you get incompatible encoding errors when generating the site under Windows, then ensure that the console in which you are running jekyll can work with UTF-8 characters. As described in the blog Solving UTF problem with Jekyll on Windows you have to execute chcp 65001. This command is best added to the jekyll.bat-script.


The markdown used in this site uses kramdown extensions.

Markdown Editor for OSX

There's a free markdown editor for OSX called Mou. It's quite convenient to work with, and it generates the translated Markdown in real-time alongside of your editor window, as can be seen here:

Mou Screen Shot


All documentation contained in this repository is licensed by EPFL under a Creative Commons Attribution-Share Alike 3.0 Unported license ("CC-BY-SA"), unless otherwise noted. By submitting a "pull request," or otherwise contributing to this repository, you implicitly agree to license your contribution under the above CC-BY-SA license. The source code of this website is licensed to EPFL under the Scala License, unless otherwise noted.