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
./collections/_postsdirectory 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: 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_data/authors.yml. - Write your content using Markdown. For code highlighting, use the usual GitHub syntax:
def yourCode: HereIf 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.
To preview your changes, you have to install Bundler first. To download and set up all necessary dependencies, run
$ bundle install
... 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
$ bundle exec jekyll serve -wl --baseurl ''The generated site will end up in the _site directory.
A fully configured Jekyll is available as a Nix app. Assumes that you have installed Nix and enabled flakes. You may optionally use the Typelevel Cachix.
$ nix run github:typelevel/typelevel.github.com#jekyll build
warning: Git tree '/Users/ross.baker/src/typelevel.github.com' is dirty
Configuration file: /Users/ross.baker/src/typelevel.github.com/_config.yml
Source: /Users/ross.baker/src/typelevel.github.com
Destination: /Users/ross.baker/src/typelevel.github.com/_site
Incremental build: disabled. Enable with --incremental
Generating...
done in 3.635 seconds.
Auto-regeneration: disabled. Use --watch to enable.There is also a devshell for direct invocation, and a convenient alias:
$ nix develop github:typelevel/typelevel.github.com
🔨 Welcome to typelevel-org-shell
[general commands]
jekyll - a jekyll bundled with this site's dependencies
menu - prints this menu
tl-preview - preview the Jekyll site
$ tl-preview
Configuration file: /home/you/src/typelevel.github.com/_config.yml
Source: /home/you/src/typelevel.github.com
Destination: /home/you/src/typelevel.github.com/_site
Incremental build: disabled. Enable with --incremental
Generating...
done in 3.336 seconds.
Auto-regeneration: enabled for '/home/you/src/typelevel.github.com'
LiveReload address: http://127.0.0.1:35729
Server address: http://127.0.0.1:4000/
Server running... press ctrl-c to stop.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 _sass directories.
It is being processed/compiled into regular CSS by Jekyll.
├── css/
│ ├── main.scss # Custom CSS, brings all stylesheets together
├── _sass/
│ ├── base/
│ ├── components/
│ ├── utils/
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: organization projects, affiliate projects, and core/featured projects.
To add an organization project, insert a new entry, alphabetically, in the _data/projects.yml file with the following keys:
- title: "Cats"
description: "A library intended to provide abstractions for functional programming in Scala, leveraging its unique features. Design goals are approachability, modularity, documentation and efficiency."
github: "https://github.com/typelevel/cats"
platforms: [js, jvm, native]
permalink: "https://typelevel.org/cats/" # optionalRight now nothing more than the correct front matter is required.
To add
- an affiliate project, add
affiliate: trueto the project entry - a core project, add
core: trueto the project entry
To add a page,
- Create a directory in the root of the project, with at least an
index.htmlfile in that directory. - Update
_data/nav.ymlto add it to the navigation. (The site navigation is not fully dynamic for simplification.)
Sample front matter for a page:
layout: page
title: "Code of Conduct"We need to update the gemset as well.
nix run nixpkgs#bundix
git commit -am "Update gemset"
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
