Repository files navigation

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 athttp://docs.scala-lang.org/contribute.html 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 ofexisting documents will be thoroughly reviewed-- please keep in mind that, generally, new documents must be very well-polished, complete, and maintainedin order to be accepted.

Jekyll is required. Follow the install instructions at the Jekylldocumentation site. Since this site is hosted on github pages, make sure you havewhatever version of Jekyll that github is running. As of the writing of this README, that is version >= 1.0.x.

cd into thescala.github.com directory, and build by:

jekyll serve

The generated site is available athttp://localhost:4000

If you getincompatible encoding errors when generating the site under Windows, then ensure that theconsole in which you are running jekyll can work with UTF-8 characters. As described in the blogSolving UTF problem with Jekyll on Windowsyou have to executechcp 65001. This command is best added to thejekyll.bat-script.

The markdown used in this site usesMaruku extensions.

There exists a free markdown editor for OSX calledMou. 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:

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 theScala License, unless otherwise noted.