This is the website of typelevel.scala. It is built on Jekyll and served at typelevel.org.
If you just want to add a blog post or fix a typo in the content, here's how to get started.
- Create a new file in the
posts
directory or copy an existing post. Its name should have the formatYYYY-MM-DD-short_title.md
. - Set the
title
(short title of the post, appears as the HTML<title>
) andauthor
(your GitHub user name) in the front matter. MathJax is available viamathjax: true
inside 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
author
field from the front matter. Add your details in_data/authors.yml
. - 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 _data/authors.yml
.
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.
You can also use tut
in posts. See posts/2016-09-30-subtype-typeclasses.md
for an example.
To preview your changes, you have to install Rake and Bundler first. To download and set up all necessary dependencies, run
$ rake init
... lots of text ...
Bundle complete! 1 Gemfile dependency, 81 gems now installed.
Bundled gems are installed into `./vendor/bundle`
Then, you can generate the site by running
$ rake build
The generated site will end up in the _site
directory.
For a local development cycle (i.e., edit, recompile post, serve website), use
$ rake dev
This will spin up an sbt and a Jekyll instance in parallel. When making changes to a post, sbt will re-run tut, after which Jekyll will re-render (which takes a moment).
When you send a pull request, Netlify will automatically build a rendered preview of the site.
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 css
and _scss
directories.
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.)
Javascript can be found in the 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 blog/
.
Images for styling purposes are located inside img/
, photos inside img/media/
.
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 core: true
.
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"
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 (_layouts/default.html
).
Sample front matter for a page:
layout: page
title: "Code of Conduct"