README.md

sbt-docs

SBT plugin for publishing markdown documentation to github pages

Usage

This plugin requires sbt 1.0.0+

Getting Started

Setup

Create project/plugins.sbt:

resolvers += "jitpack" at "https://jitpack.io"
libraryDependencies += "com.github.tmtsoftware" % "sbt-docs" % "0.5.0"

Inside build.sbt, add DocsPlugin to a subproject:

lazy val docs = project
  .in(file("."))
  .enablePlugins(DocsPlugin)
  .settings(
    docsRepo := "https://github.com/tmtsoftware/sbt-docs",
    docsParentDir := "sbt-docs",
    gitCurrentRepo := "https://github.com/tmtsoftware/sbt-docs"
  )

• docsRepo: The remote git repository where documents will be published"
• docsParentDir: Parent directory where generated documentation will be published
• gitCurrentRepo: The remote git repository associated with this project

Testing

Run test for regular unit tests.

Run scripted for sbt script tests.

Publishing

Steps to publish for first time

1. publish your source to GitHub
2. Add your plugin to the community plugins list
3. Claim your project an Scaladex

Steps to publish successive versions

1. run sbt clean test scripted
2. create git tag with version to publish and push tag and sources to github
3. Publish a github release using Github UI