Skip to content
The Scala Documentation website
JavaScript HTML CSS Ruby
Latest commit 15652c1 May 19, 2016 @heathermiller heathermiller Merge pull request #529 from adamwy/master
Fix typos in collections overview
Failed to load latest commit information.
.bundle Install gems into vendor/bundle. Gitignore vendor/bundle, and tell je… Nov 29, 2014
_data Fixes scala/scala.github.com#448. Replace flags with endonyms. Aug 23, 2015
_includes Better algolia autocomplete Feb 8, 2016
_layouts Rename files names back to the original. Fix misbehaving language hea… Aug 24, 2015
cheatsheets fix a couple mistakes in the cheatsheet Jul 23, 2015
de/tutorials tour: polymorphic methods Jun 13, 2012
es Merge pull request #502 from raboof/promises Mar 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/scala-for-java-programmers.md Apr 1, 2016
ja Fix links to quasiquotes overview Mar 24, 2016
ko/tutorials Update TraitsTest sample to extend App instead of Application Oct 14, 2015
news/_posts I hate jekyll Jul 1, 2013
overviews Merge pull request #529 from adamwy/master May 19, 2016
pt-br/cheatsheets revert addition of Brazilian collections overview Aug 24, 2015
resources Better algolia autocomplete Feb 8, 2016
sips Change 'future' to 'Future' in examples Mar 15, 2016
style Reword for clarity (minor improvement) Apr 2, 2016
tutorials fix up it/tutorials/scala-for-java-programmers.md Apr 1, 2016
zh-cn/overviews Merge pull request #502 from raboof/promises Mar 22, 2016
.gitignore Merge pull request #466 from SethTisue/views-usually-means-collection… Dec 8, 2015
.travis.yml add a Travis-CI build Jan 7, 2016
CNAME Adding CNAME for domain redirect for docs.scala-lang.org Oct 26, 2011
Gemfile adds Gemfile as recommended by Github Nov 23, 2013
Gemfile.lock update to GitHub Pages 3.0 Feb 9, 2016
README.md Docs on building docs are actually in the README Jan 16, 2016
_config.yml update to GitHub Pages 3.0 Feb 9, 2016
conduct.html Code of Conduct is on main Scala site now Dec 18, 2015
contribute.md Minor improvements Mar 22, 2016
index.md 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

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.

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

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:

bundle exec jekyll serve

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. It can take a few minutes for your changes to appear. Watch Jekyll's output. When you start up you'll see this:

 $ bundle exec jekyll serve --watch
 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 says done.

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 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 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

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.