ZIO SBT is an sbt plugin for ZIO projects. It provides high-level SBT utilities that simplify the development of ZIO applications.

Add the following lines to your plugin.sbt file:

addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.0.2")

Then you can enable it by using the following code in your build.sbt file:

enablePlugins(WebsitePlugin)

ZIO SBT Website is an SBT plugin that has the following tasks:

• sbt compileDocs— compile documentation inside docs directory. The compilation result will be inside website/docs directory.
• sbt installWebsite— creates a website for the project inside the website directory.
• sbt previewWebsite— runs a local webserver that serves documentation locally on http://localhost:3000. By changing the documentation inside the docs directory, the website will be reloaded with new content.
• sbt publishToNpm— publishes documentation inside the docs directory to the npm registry.
• sbt generateGithubWorkflow— generates GitHub workflow which publishes documentation for each library release.
• sbt generateReadme— generate README.md file from docs/index.md and sbt setting keys.

Learn more on the ZIO SBT homepage!

For the general guidelines, see ZIO contributor's guide.

Before you submit a PR, make sure your tests are passing, and that the code is properly formatted

sbt prepare

sbt testPlugin

See the Code of Conduct

Come chat with us on .

License