Scaladoc

Built-in blog

Language
This doc page is specific to Scala 3, and may cover new concepts not available in Scala 2.

Scaladoc allows you to include a simple blog in your documentation. For now, it provides only basic features. In the future, we plan to include more advanced features like tagging or author pages.

Blog is treated a little differently than regular static sites. This article will help you set up your own blog.

Proper directory setup

All your blogposts must be put under _blog/_posts directory.

├── _blog
│   ├── _posts
│   │   └── 2016-12-05-implicit-function-types.md
│   └── index.html

Scaladoc loads blog if the _blog directory exists.

Naming convention

All the blogpost filenames should start with date in numeric format matching YYYY-MM-DD. Example name is 2015-10-23-dotty-compiler-bootstraps.md.

Contributors to this page: