scaladoc logo

scaladoc is a tool to generate documentation for your Scala 3 projects. It provides similar features to javadoc as well as jekyll or docusaurus.

As you probably have guessed, this whole site was created using scaladoc.

API Documentation

Scaladoc's main feature is creating API documentation from code comments.

(read more)

Built-in blog

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.

(read more)

Scaladoc-specific Tags and Features

Scaladoc extends Markdown with additional features, such as linking to API definitions. This can be used from within static documentation and blog posts to provide blend-in content.

(read more)

Static documentation

Scaladoc is able to generate static sites, known from Jekyll or Docusaurus. Having a combined tool allows to provide interaction between static documentation and API, thus allowing the two to blend naturally.

(read more)

Other extensions

We would love to have your feedback on what you think would be good in order to render the documentation you want! Perhaps you would like to render method definitions or members? Do you want to have runnable code snippets? Let us know by filing issues!