• Stars
    star
    548
  • Rank 76,506 (Top 2 %)
  • Language
    HTML
  • Created over 12 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The Scala Documentation website

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 --user-install bundler jekyll
bundle exec jekyll serve -I

(Trouble on MacOS?)

For more details, read on.

Quickstart with Docker Compose

You need to have Docker Engine and Docker Compose installed on your machine. Under macOS (Intel or Apple silicon), instead of installing Docker Desktop you can also use HomeBrew with Colima: brew install colima docker docker-compose.
UID and GID environment variables are needed to avoid docker from writing files as root in your directory. By default, docker-compose will use the file docker-compose.yml which will build the website and serve it on 0.0.0.0:4000 . If you just need to build the website, add -f docker-compose_build-only.yml

env UID="$(id -u)" GID="$(id -g)" docker-compose up

The generated site is available at http://localhost:4000.

When the website dependencies change (the content of the Gemfile), you have to re-build the Docker image:

env UID="$(id -u)" GID="$(id -g)" docker-compose up --build

If you have problems with the Docker image or want to force the rebuild of the Docker image:

env UID="$(id -u)" GID="$(id -g)" docker-compose build --no-cache

For more details on the Docker option, see also this issue.

Contributing

Please have a look at Add New Guides/Tutorials 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 MacDown. 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:

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

More Repositories

1

scala

Scala 2 compiler and standard library. Bugs at https://github.com/scala/bug; Scala 3 at https://github.com/lampepfl/dotty
Scala
14,232
star
2

scala-async

An asynchronous programming facility for Scala
Scala
1,137
star
3

pickling

Fast, customizable, boilerplate-free pickling support for Scala
Scala
833
star
4

scala-parser-combinators

simple combinator-based parsing for Scala. formerly part of the Scala standard library, now a separate community-maintained module
Scala
635
star
5

scala-java8-compat

A Java 8 compatibility kit for Scala.
Scala
436
star
6

legacy-svn-scala

OBSOLETE, we're over there:
Scala
366
star
7

scala3-example-project

An example sbt project that compiles using Dotty
Scala
328
star
8

scala-xml

The standard Scala XML library
Scala
290
star
9

scala-dist

sbt project that packages the Scala distribution
Scala
278
star
10

scala-lang

sources for the Scala language website
SCSS
256
star
11

scala-abide

obsolete; visit https://github.com/scalacenter/scalafix instead
Scala
234
star
12

bug

Scala 2 bug reports only. Please, no questions โ€” proper bug reports only.
229
star
13

collection-strawman

Implementation of the new Scala 2.13 Collections
Scala
202
star
14

scala-collection-compat

makes some Scala 2.13 APIs (primarily collections, also some others) available on 2.11 and 2.12, to aid cross-building
Scala
194
star
15

scala-parallel-collections

Parallel collections standard library module for Scala 2.13+
Scala
191
star
16

scala-seed.g8

Giter8 template for a simple hello world app in Scala.
Scala
147
star
17

scala-swing

Scala wrappers for Java's Swing API for desktop GUIs
Scala
126
star
18

community-build

Scala 2 community build โ€”ย a corpus of open-source repos built against Scala nightlies
Shell
126
star
19

scala-dev

Scala 2 team issues. Not for user-facing bugs or directly actionable user-facing improvements. For build/test/infra and for longer-term planning and idea tracking. Our bug tracker is at https://github.com/scala/bug/issues
126
star
20

scala3.g8

Scala
120
star
21

scala-collection-contrib

community-contributed additions to the Scala 2.13 collections
Scala
106
star
22

scala-module-dependency-sample

Depend on Scala modules like a pro
Scala
96
star
23

scala-continuations

the Scala delimited continuations plugin and library
Scala
89
star
24

make-release-notes

The project that generates Scala release notes.
HTML
85
star
25

toolkit

The batteries-included Scala
Scala
77
star
26

vscode-scala-syntax

Visual Studio Code extension for syntax highlighting Scala sources
Scala
70
star
27

slip

obsolete โ€”ย archival use only
69
star
28

compiler-benchmark

Benchmarks for scalac
Scala
68
star
29

scala-library-next

backwards-binary-compatible Scala standard library additions
Scala
66
star
30

improvement-proposals

Scala Improvement Proposals
39
star
31

scala.epfl.ch

web site for the Scala Center @ EPFL
SCSS
37
star
32

scala-tool-support

XML
34
star
33

hello-world.g8

Scala
27
star
34

scala-collection-laws

partially-automatic generation of tests for the entire collections library
Scala
21
star
35

scala3-cross.g8

Scala
16
star
36

scabot

Scala's PR&CI automation bot
Scala
14
star
37

scala-jenkins-infra

A Chef cookbook that manages Scala's CI infrastructure.
Shell
14
star
38

scalatest-example.g8

Scala
13
star
39

sbt-scala-module

sbt plugin for scala modules.
Scala
13
star
40

scala-asm

A fork of https://gitlab.ow2.org/asm/asm for the Scala compiler
12
star
41

scala3-mill-example-project

Shell
11
star
42

compiler-interface

a binary contract between Zinc and Scala Compilers
Scala
10
star
43

scala-partest

Legacy repo for testing framework for Scala versions <= 2.12
Scala
9
star
44

scala-asm-legacy

A fork of asm.ow2.org for the Scala compiler
Java
8
star
45

scala3-staging.g8

Scala
6
star
46

scala-modules-build

Build support for the various Scala Modules
Shell
1
star
47

actors-migration

Scala
1
star
48

scala-partest-interface

SBT interface to partest
1
star
49

scala-library-all

Conglomerate pom file to pull in components of Scala standard library easily.
Scala
1
star
50

scala-dist-smoketest

Smoke Test for newly created Scala distributions
Shell
1
star