sbt/website

Name: website

Owner: sbt

Description: The source for scala-sbt.org

Created: 2014-05-01 20:17:33.0

Updated: 2018-01-15 14:48:28.0

Pushed: 2018-01-18 17:02:18.0

Homepage: https://www.scala-sbt.org/

Size: 7037

Language: Scala

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

scala-sbt.org

This project is the source for scala-sbt.org. See contributors for the list of documentation contributors.

scala-sbt.org is powered by two static site engines.

nanoc is used for the landing pages.

Pamflet, a Scala-based documentation engine written by @n8han (and some contributions from @eed3si9n) generates 0.13+ documentations.

These two engines are driven by sbt-site and sbt-ghpages. We will shortly use pandoc to also generate pdf files.

Attention plugin authors

The source for Community plugins page is at src/reference/01-General-Info/02-Community-Plugins.md. Fork this project, add your plugin and send us a pull request if your plugin is not already on it.

Setup

Currently, nanoc requires Ruby 2.1 or greater.

You'll need the following gems for running nanoc:

m install nanoc:4.0.2
m install redcarpet
m install nokogiri

If you're running ubuntu, you'll need to also install ruby-dev for the native-code in redcarpet, and pandoc/latex for PDF generation:

do add-apt-repository ppa:texlive-backports/ppa
do apt-get update
do apt-get install ruby-dev pandoc latex-cjk-all texlive-full

On Mac

• download and install MacTEX
• sudo tlmgr update --self --all
• follow https://oku.edu.mie-u.ac.jp/~okumura/texwiki/?TeX%20Live%2FMac#bcb0d462
• brew install pandoc

Usage

To make site locally, from sbt shell:

keSite

To push site, from sbt shell:

pagesPushSite

Beware of https://github.com/sbt/sbt-ghpages/issues/25

Releasing new sbt

• Update sbt.version in project/build.properties
• Update targetSbtFullVersion in project/Docs.scala
• Add last release to “Previous releases” in src/nanoc/nanoc.yaml
• Update sbtVersion, windowsBuild and sbtVersionForScalaDoc in src/reference/template.properties

Including code examples

To include a validated code examples, create a scripted test under src/sbt-test, and in the markdown include as:

his includes the entire file as Scala code snippet
ip [build.sbt]($root$/src/sbt-test/ref/basic/build.sbt) {}



his includes snippet between a line containing #example another line with #example
ip [build.sbt]($root$/src/sbt-test/ref/basic/build.sbt) { #example }



his specifies syntax highlight
ip [build.sbt]($root$/src/sbt-test/ref/basic/build.sbt) { #example type=text }