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, the repository's structure, and how to build and run the documentation locally.

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.

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

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

Start the server in the context of the bundle:

bundle exec jekyll serve

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

Jekyll will automatically watch for changes on the filesystem, and regenerate the site. It can take a few minutes for your changes to appear. Watch the output fromjekyll serve. When you start up you'll see this:

 $ bundle exec jekyll serve Configuration file: /Users/ben/src/scala.github.com/_config.yml             Source: /Users/ben/src/scala.github.com        Destination: /Users/ben/src/scala.github.com/_site      Generating...                 done.Auto-regeneration: enabled for '/Users/ben/src/scala.github.com'

When you change a file, this output will tell you that jekyll is regenerating. It's not done until it saysdone.

Server running... press ctrl-c to stop.  Regenerating: 1 files at 2014-11-29 09:19:04 ...done.  Regenerating: 3 files at 2014-11-29 09:21:39 ...done.  Regenerating: 2 files at 2014-11-29 09:25:10 ...done.  Regenerating: 2 files at 2014-11-29 09:27:49

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 useskramdown extensions.

There's 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.