Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
JavaScript
branch: gh-pages

This branch is 6 commits ahead, 18 commits behind HamsterofDeath:gh-pages

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
_includes
_layouts
cheatsheets
glossary
overviews
resources
sips.new
style
tutorials
.gitignore
CNAME
README.md
_config.yml
contribute.md
index.md
search.html

README.md

Scala Documentation

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

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

Markdown

The markdown used in this site uses Maruku extensions.

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.

Something went wrong with that request. Please try again.