The Scala Documentation website
Switch branches/tags
Nothing to show
Clone or download
Latest commit edadc3e Oct 18, 2018
Permalink
Failed to load latest commit information.
.bundle Upgraded jekyll to 3.3.0 using bundle update Nov 4, 2016
_ba #850:Tuples page added to tour Sep 16, 2018
_books Fix all external links Dec 5, 2017
_data Add `-Yvalidate-pos` introduced in scala 2.12.7 Sep 27, 2018
_de/tutorials merge scala-master Jan 10, 2018
_es #850:Tuples page added to tour Sep 16, 2018
_fr/cheatsheets merge scala-master Jan 10, 2018
_includes Used toc-context class to identify where toc should look for headings Sep 24, 2018
_it/tutorials merge scala-master Jan 10, 2018
_ja Updated ja and zh-cn collections overview pages to use new diagrams Oct 9, 2018
_ko #850:Tuples page added to tour Sep 16, 2018
_layouts Used toc-context class to identify where toc should look for headings Sep 24, 2018
_overviews Fix typo Oct 18, 2018
_pl #850:Tuples page added to tour Sep 16, 2018
_plugins merge scala-master Jan 10, 2018
_pt-br #850:Tuples page added to tour Sep 16, 2018
_ru/overviews/parallel-collections Remove leftovers of anonymous-function-syntax Dec 5, 2017
_sass Add Algolia search for documentation. Need test in prod. (#1096) Jul 9, 2018
_sips Merge pull request #1176 from darjutak/darjutak-august-18-minutes Oct 18, 2018
_style add implicit keyword to the Modifiers section #1075 Jul 12, 2018
_th #850:Tuples page added to tour Sep 16, 2018
_tour Merge pull request #1165 from rkoeninger/redirect-refinement-type-exp… Oct 10, 2018
_zh-cn Updated ja and zh-cn collections overview pages to use new diagrams Oct 9, 2018
_zh-tw/tutorials merge scala-master Jan 10, 2018
api Make all links https-links Aug 4, 2018
getting-started-intellij-track Update getting-started-with-scala-in-intellij.md Jun 17, 2018
getting-started-sbt-track Update testing-scala-with-sbt-on-the-command-line.md Aug 15, 2018
glossary merge scala-master Jan 10, 2018
news/_posts merge scala-master Jan 10, 2018
resources Fixed collections mutable diagram to show PriorityQueue is Iterable, … Oct 9, 2018
scripts Ignoring www.oracle.com links in htmlproofer in ci build Oct 9, 2018
.drone.yml merge scala-master Jan 10, 2018
.drone.yml.sig merge scala-master Jan 10, 2018
.gitignore merge scala-master Jan 10, 2018
CODE_OF_CONDUCT.md merge scala-master Jan 10, 2018
Gemfile Merge branch 'master' into scalafiddle-integration Jan 29, 2018
Gemfile.lock Update Jekyll to 3.8 Aug 1, 2018
README.md merge scala-master Jan 10, 2018
_config.yml Add initial Thai translation Jul 26, 2018
books.md merge scala-master Jan 10, 2018
conduct.html merge scala-master Jan 10, 2018
contribute.md Fix all external links Dec 5, 2017
getting-started.md merge scala-master Jan 10, 2018
guides.md merge scala-master Jan 10, 2018
index.md language tour: say what the intent and audience are (#993) Jan 17, 2018
learn.md correction: Youtube -> YouTube Jun 26, 2018
reference.md merge scala-master Jan 10, 2018

README.md

Scala Documentation

Build Status

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

Quickstart

To build and view the site locally:

gem install bundler
bundle install
bundle exec jekyll serve -I

For more details, read on.

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 (use -I for incremental builds):

bundle exec jekyll serve -I

It might take around 5 minutes at first but incremental compilations will be fast.

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.

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.