This is the website of typelevel.scala. It is built on Jekyll and served at typelevel.org.
- The default branch is now
masteris the target for automated commits from Travis. Please
git checkout developmentfor doing anything.
- Posts go into
sbt runto have them copied over.
- You can use
tutin posts. See
posts/2016-09-30-subtype-typeclasses.mdfor an example.
Getting Started (the short version)
If you just want to add a blog post or fix a typo in the content, here's how to get started.
Creating a blog post
- Create a new file in the
postsdirectory or copy an existing post. Its name should have the format
- Set the
title(short title of the post, appears as the HTML
author(your GitHub user name) in the front matter. MathJax is available via
mathjax: trueinside the front matter.
- If this is your first blog post, please indicate if you want your name and a profile picture to appear on the post. If not, you can remove the
authorfield from the front matter. Add your details in
- Write your content using Markdown. For code highlighting, use the usual GitHub syntax:
def yourCode: Here
If you haven't written a post before, please add yourself to
That's it, we'll take care of the rest. If you wish, you can also submit just a plain Markdown file and we'll be happy to integrate it.
Previewing your changes
To preview your changes, you have to install Ruby, Bundler and SBT first. Once you've done that, you can start the Jekyll server like this:
sbt run bundle install bundle exec jekyll serve --baseurl ''
This will first preprocess the blog posts and then start a local web server on port 4000 where you can browse the site. For automatic site rebuild, run the following two commands in different terminals:
sbt ~run bundle exec jekyll serve --incremental --baseurl ''
This will trigger a recompile and rebuild if you change the source files.
Two different licenses apply:
- The Scala code, including the SBT build definition, is licensed under the MIT License.
- Unless otherwise noted, all website content is licensed under a Creative Commons Attribution 3.0 Unported License.
The stylesheets are written in SASS, and can be found in the
It is being processed/compiled into regular CSS by Jekyll.
├── css/ │ ├── main.scss # Custom CSS, brings all stylesheets together ├── _scss/ │ ├── _fonts.scss # @font-face embedding. │ ├── _mixins.scss # SASS mixins │ ├── _reset.scss # Normalize stylesheet │ ├── _syntax.scss # Syntax highlighting by Pygments │ ├── _variables.scss # SASS variables (colors, fonts, etc.)
js/ folder, which also includes its dependencies.
All templates/layouts can be found in the
_layouts folder, except the blog layout, which is located inside its own subfolder
Images for styling purposes are located inside
img/, photos inside
Adding a project
There are three types of projects: core/featured projects, regular projecs, and macros.
To add a regular project, create a new markdown file in the
_projects folder with the following front matter:
layout: post title: "Cats" category: "Functional Programming" description: "An experimental library intended to provide abstractions for functional programming in Scala, leveraging its unique features. Design goals are approachability, modularity, documentation and efficiency." permalink: "https://non.github.io/cats/" github: "https://github.com/non/cats"
Right now nothing more than the correct front matter is required.
Do the same for a core/featured project, but also add
To add companions or extensions to these projects, use the front matter, too:
extensions: - title: "Dogs" description: "Functional data structures" github: "https://github.com/stew/dogs" - title: "Alleycats" description: "Lawless classes & illegal instances" github: "https://github.com/non/alleycats"
Macros are created a little differently. They are located in
_data/macros.yml and look like this:
- title: "imp" description: "Summoning implicit values" github: "https://github.com/non/imp"
Adding a page
To add a page, create a HTML or Markdown file in the root of the project. The site navgation is not fully dynamic for simplification purposes. It can be changed in the default layout (
Sample front matter for a page:
layout: page title: "Code of Conduct"