Skip to content
This repository

The Scala Documentation website

branch: master

Merge pull request #337 from xeno-by/master

updates macro annotation docs
latest commit 4b6e4cec4a
Eugene Burmako xeno-by authored April 18, 2014
Octocat-spinner-32 _includes Fixes broken link to nightly API docs in topbar. August 13, 2013
Octocat-spinner-32 _layouts Merge pull request #134 from scalajp/topic/overview-fix December 20, 2012
Octocat-spinner-32 cheatsheets Translation of cheatsheet do portuguese-brazil July 18, 2013
Octocat-spinner-32 de tour: polymorphic methods June 13, 2012
Octocat-spinner-32 es corrected some words July 30, 2013
Octocat-spinner-32 fr Adds way to toggle between languages for cheatsheets in response to #182 February 24, 2013
Octocat-spinner-32 glossary Fixes a broken link in the glossary May 13, 2012
Octocat-spinner-32 ja Merge pull request #316 from xeno-by/master March 16, 2014
Octocat-spinner-32 ko Add Korean translation of Scala Tutorial (Java) April 11, 2012
Octocat-spinner-32 news I hate jekyll July 01, 2013
Octocat-spinner-32 overviews updates macro annotation docs April 18, 2014
Octocat-spinner-32 pt-br Changed the text of \'about\' July 26, 2013
Octocat-spinner-32 resources Fix for sidebar scroller September 02, 2013
Octocat-spinner-32 sips Move completed SIPs from "pending" to "completed" ... December 22, 2013
Octocat-spinner-32 style Merging two contribution, naming conventions for constants October 07, 2013
Octocat-spinner-32 tutorials fixes #270 November 23, 2013
Octocat-spinner-32 .gitignore Translated automatic-closures.md November 16, 2011
Octocat-spinner-32 CNAME Adding CNAME for domain redirect for docs.scala-lang.org October 26, 2011
Octocat-spinner-32 Gemfile adds Gemfile as recommended by Github November 23, 2013
Octocat-spinner-32 README.md use proper `jekyll serve` instead of `server` which will build the si… August 07, 2013
Octocat-spinner-32 _config.yml fixes the breakage introduced in jekyll 1.0 May 19, 2013
Octocat-spinner-32 conduct.md Add notice about job postings February 14, 2013
Octocat-spinner-32 contribute.md Set the correct page layout August 30, 2012
Octocat-spinner-32 index.md Progress on front page, and navigation. October 19, 2011
Octocat-spinner-32 search.html More hacks to fix issues caused by the need for a sticky footer. This… October 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

Jekyll is required. Follow the install instructions at the Jekyll documentation site. Since this site is hosted on github pages, make sure you have whatever version of Jekyll that github is running. As of the writing of this README, that is version >= 1.0.x.

Building & Viewing

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

jekyll serve

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.

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

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.