axel22/scala.github.com

Scala Documentation

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

Contributing

Please have a look at http://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 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.

Dependencies

Unix

Jekyll is required. Follow the install instructions at the Jekyll wiki. In most cases, you can install via RubyGems:

gem install jekyll

OSX users might need to update RubyGems:

sudo gem update --system

Windows

Grab the RubyInstaller. Try release 1.8.x if you experience unicode problems with 1.9.x.

Follow the instructions for RubyInstaller DevKit.

Install Jekyll using the gem package manager:

gem install jekyll

Building & Viewing

cd into the scala.github.com directory, and build by:

jekyll --server

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

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.

Markdown

The markdown used in this site uses Maruku extensions.

Markdwn Editor for OSX

There exists 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:

License

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.