Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The Scala Documentation website
JavaScript HTML CSS Ruby

Merge pull request #443 from fagossa/master

Fixes spanish typos and translation errors
latest commit 64c8efb078
@heathermiller heathermiller authored
Failed to load latest commit information.
.bundle Install gems into vendor/bundle. Gitignore vendor/bundle, and tell je…
_data Fixes scala/scala.github.com#448. Replace flags with endonyms.
_includes Fixes scala/scala.github.com#448. Replace flags with endonyms.
_layouts Rename files names back to the original. Fix misbehaving language hea…
cheatsheets fix a couple mistakes in the cheatsheet
de/tutorials tour: polymorphic methods
es Merge pull request #443 from fagossa/master
fr/cheatsheets replace h2 tag by span tag like english version.
glossary Merge pull request #286 from Debilski/quote-fix
ja modify some expression
ko/tutorials remove references to CLR/.NET
news/_posts I hate jekyll
overviews revert addition of Brazilian collections overview
pt-br/cheatsheets revert addition of Brazilian collections overview
resources Fixes scala/scala.github.com#448. Replace flags with endonyms.
sips Add sip-template.md since slip template removed.
style Fix a couple formatting errors in the style guide
tutorials Merge pull request #447 from SethTisue/omit-clr-references
zh-cn/overviews Fix image
.gitignore Install gems into vendor/bundle. Gitignore vendor/bundle, and tell je…
CNAME Adding CNAME for domain redirect for docs.scala-lang.org
Gemfile adds Gemfile as recommended by Github
Gemfile.lock Add Gemfile.lock
README.md Install gems into vendor/bundle. Gitignore vendor/bundle, and tell je…
_config.yml Install gems into vendor/bundle. Gitignore vendor/bundle, and tell je…
conduct.md Add notice about job postings
contribute.md Added scaladoc overview pages, updated overview index, added links fo…
index.md Progress on front page, and navigation.
search.html More hacks to fix issues caused by the need for a sticky footer. This…

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

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 from jekyll 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 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.