Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sbt-header plugins should handle md files in docs project #11245

Merged
merged 1 commit into from
Apr 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Build documentation

This is the README for the Play documentation project. The documentation project does not build with the rest of the Play projects, and uses its own sbt setup instead. Please refer to the [main README file](../README.md) for how to build Play in general and how to [contribute](../CONTRIBUTING.md).
Expand Down
10 changes: 9 additions & 1 deletion documentation/build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ import playbuild.JavaVersion
import playbuild.CrossJava

import de.heikoseeberger.sbtheader.FileType
import de.heikoseeberger.sbtheader.CommentCreator
import de.heikoseeberger.sbtheader.CommentStyle
import de.heikoseeberger.sbtheader.HeaderPlugin.autoImport.HeaderPattern.commentBetween

val DocsApplication = config("docs").hide

Expand Down Expand Up @@ -82,8 +84,14 @@ lazy val main = Project("Play-Documentation", file("."))
headerLicense := Some(HeaderLicense.Custom("Copyright (C) Lightbend Inc. <https://www.lightbend.com>")),
headerMappings ++= Map(
FileType.xml -> CommentStyle.xmlStyleBlockComment,
FileType.conf -> CommentStyle.hashLineComment
FileType.conf -> CommentStyle.hashLineComment,
FileType("md") -> CommentStyle(new CommentCreator() {
override def apply(text: String, existingText: Option[String]): String = {
s"<!--- $text -->"
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened sbt/sbt-header#285 to simplify the CommentStyle config even more.

}, commentBetween("<!---", "*", "-->"))
),
Test / headerSources ++= (baseDirectory.value ** "*.md").get,
Test / javafmt / sourceDirectories ++= (Test / unmanagedSourceDirectories).value,
Test / javafmt / sourceDirectories ++= (Test / unmanagedResourceDirectories).value,
// No need to show eviction warnings for Play documentation.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/Home.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play %PLAY_VERSION% documentation

> Play is a high-productivity Java and Scala web application framework that integrates the components and APIs you need for modern web application development.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/LatestRelease.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Latest release

Learn more about the latest Play release. You can download Play releases [here](https://www.playframework.com/download).
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/ModuleDirectory.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play modules

Play uses public modules to augment built-in functionality.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/about/Philosophy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Introducing Play 2

Since 2007, we have been working on making Java web application development easier. Play started as an internal project at Zenexity (now [Zengularity](https://zengularity.com/en)) and was heavily influenced by our way of doing web projects: focusing on developer productivity, respecting web architecture, and using a fresh approach to packaging conventions from the start — breaking so-called JEE best practices where it made sense.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/gettingStarted/Anatomy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Anatomy of a Play application

## The Play application layout
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/gettingStarted/IDE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Setting up your preferred IDE

Working with Play is easy. You don’t even need a sophisticated IDE, because Play compiles and refreshes the modifications you make to your source files automatically, so you can easily work using a simple text editor.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/gettingStarted/Installing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Installing Play

This page shows how to download, install and run a Play application. There's a built in tutorial that shows you around, so running this Play application will show you how Play itself works!
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/gettingStarted/LearningExamples.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Learning from Play Examples

[Lightbend Tech Hub](https://developer.lightbend.com/start/?group=play) offers downloadable Play examples for Java and Scala. Play has many features, so rather than pack them all into one project, we've organized many examples that each showcase a Play feature or demonstrate a common use case. The zip files include everything you need to build and run the examples, including a distribution of the sbt and Gradle. Refer to the `README.md` file in the top-level project directory to learn more about the example.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/gettingStarted/NewApplication.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Creating a New Application

Play expects a specific project structure. If you already have [sbt installed](https://www.scala-sbt.org/1.x/docs/Setup.html), you can use a [giter8](http://www.foundweekends.org/giter8/) template, similar to a Maven archetype, to create a new Play project. This gives you the advantage of setting up your project folders, build structure, and development environment — all with one command.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/hacking/BuildingFromSource.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Building Play from source

If you want to use some unreleased changes for Play, or you want to contribute to the development of Play yourself, you'll need to compile Play from the source code. You’ll need a [Git client](https://git-scm.com/) to fetch the source.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/hacking/Documentation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Guidelines for writing Play documentation

The Play documentation is written in Markdown format, with code samples extracted from compiled, run and tested source files.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/hacking/Issues.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Issues tracker

We use GitHub as our issue tracker, at:
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/hacking/Repositories.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Artifact repositories

## Maven Central
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/hacking/ThirdPartyTools.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# 3rd Party Tools

A big THANK YOU! to these sponsors for their support of open source projects.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/hacking/Translations.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Translating the Play Documentation

Play 2.3+ provides infrastructure to aid documentation translators in translating the Play documentation and keeping it up to date.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/hacking/WorkingWithGit.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Working with Git

This guide is designed to help new contributors get started with Play. Some things mentioned here are conventions that we think are good and make contributing to Play easier, but they are certainly not prescriptive, you should use what works best for you.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/Releases.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# About Play releases

Visit the [changelog page](https://www.playframework.com/changelog) to get started with the latest Play releases. This page lists all past Play releases starting from 2.x.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release21/Highlights21.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.1?

## Migration to Scala 2.10
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release21/Migration21.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play 2.1 migration guide

This is a guide for migrating from Play 2.0 to Play 2.1.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release22/Highlights22.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.2

## New results structure for Java and Scala
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release22/Migration22.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play 2.2 Migration Guide

This is a guide for migrating from Play 2.1 to Play 2.2. If you need to migrate from an earlier version of Play then you must first follow the [[Play 2.1 Migration Guide|Migration21]].
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release23/Highlights23.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.3

This page highlights the new features of Play 2.3. If you want learn about the changes you need to make to migrate to Play 2.3, check out the [[Play 2.3 Migration Guide|Migration23]].
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release23/Migration23.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play 2.3 Migration Guide

This is a guide for migrating from Play 2.2 to Play 2.3. If you need to migrate from an earlier version of Play then you must first follow the [[Play 2.2 Migration Guide|Migration22]].
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release24/Highlights24.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.4

This page highlights the new features of Play 2.4. If you want learn about the changes you need to make to migrate to Play 2.4, check out the [[Play 2.4 Migration Guide|Migration24]].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Reactive Streams integration (experimental)

> **Play experimental libraries are not ready for production use**. APIs may change. Features may not work properly.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Anorm

Anorm has been pulled out of the core of Play into a separately managed project that can have its own lifecycle. To add a dependency on it, use:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Removing `GlobalSettings`

If you are keen to use dependency injection, we are recommending that you move out of your `GlobalSettings` implementation class as much code as possible. Ideally, you should be able to refactor your code so that it is possible to eliminate your `GlobalSettings` class altogether.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play 2.4 Migration Guide

This is a guide for migrating from Play 2.3 to Play 2.4. If you need to migrate from an earlier version of Play then you must first follow the [[Play 2.3 Migration Guide|Migration23]].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Migrating Plugin to Module

> **Note:** The deprecated `play.Plugin` system is removed as of 2.5.x.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release25/Highlights25.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.5

This page highlights the new features of Play 2.5. If you want to learn about the changes you need to make to migrate to Play 2.5, check out the [[Play 2.5 Migration Guide|Migration25]].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Crypto Migration Guide

From Play 1.x, Play has come with a Crypto object that provides some cryptographic operations. This used internally by Play. The Crypto object is not mentioned in the documentation, but is mentioned as "cryptographic utilities" in the scaladoc:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Java Migration Guide

In order to better fit in to the Java 8 ecosystem, and to allow Play Java users to make more idiomatic use of Java in their applications, Play has switched to using a number of Java 8 types such as `CompletionStage` and `Function`. Play also has new Java APIs for `EssentialAction`, `EssentialFilter`, `Router`, `BodyParser` and `HttpRequestHandler`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play 2.5 Migration Guide

This is a guide for migrating from Play 2.4 to Play 2.5. If you need to migrate from an earlier version of Play then you must first follow the [[Play 2.4 Migration Guide|Migration24]].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Streams Migration Guide

Play 2.5 has made several major changes to how it streams data and response bodies.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release26/Highlights26.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.6

This page highlights the new features of Play 2.6. If you want to learn about the changes you need to make when you migrate to Play 2.6, check out the [[Play 2.6 Migration Guide|Migration26]].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Cache APIs Migration

## New packages
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# JPA Migration

## Removed Deprecated Methods
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# I18N API Migration

There are a number of changes to the I18N API to make working with messages and languages easier to use, particularly with forms and templates.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play 2.6 Migration Guide

This is a guide for migrating from Play 2.5 to Play 2.6. If you need to migrate from an earlier version of Play then you must first follow the [[Play 2.5 Migration Guide|Migration25]].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play WS Migration Guide

Play WS now has a standalone version - [https://github.com/playframework/play-ws](https://github.com/playframework/play-ws) - that can be used outside a Play project. If you have a Play sbt project, you can still add WS by adding the following line to your `build.sbt`:
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release27/Highlights27.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.7

This page highlights the new features of Play 2.7. If you want to learn about the changes you need to make when you migrate to Play 2.7, check out the [[Play 2.7 Migration Guide|Migration27]].
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release28/Highlights28.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.8

This page highlights the new features of Play 2.8. If you want to learn about the changes you need to make when you migrate to Play 2.8, check out the [[Play 2.8 Migration Guide|Migration28]].
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/releases/release29/Highlights29.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# What's new in Play 2.9

This page highlights the new features of Play 2.9. If you want to learn about the changes you need to make when you migrate to Play 2.9, check out the [[Play 2.9 Migration Guide|Migration29]].
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/tutorial/Tutorials.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Play Tutorials

Play's documentation shows the available features and how to use them, but the documentation will not show how to create an application from start to finish. This is where tutorials and examples come in.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/working/commonGuide/Modules.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Extending Play with modules

At its core, Play is a very lightweight HTTP server, providing mechanisms for serving HTTP requests, but not much else. Additional functionality in Play is provided through the use of Play modules.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Cluster Sharding for Akka Typed (incubating)

Play provides an [incubating](https://developer.lightbend.com/docs/lightbend-platform/introduction/getting-help/support-terminology.html) module for integration with [Akka Cluster Sharding Typed](https://doc.akka.io/docs/akka/2.6/typed/cluster-sharding.html). To enable this module, add the following dependency to your build:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Akka Advanced Integrations

This section covers some topics related to working with advanced features in Akka.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/working/commonGuide/akka/AkkaTyped.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Integrating with Akka Typed

Akka 2.6 marked the new typed Actor API ("Akka Typed") as stable. The typed API is now officially the main API for Akka. In the typed API, each actor needs to declares which message type it is able to handle and the type system enforces that only messages of this type can be sent to the actor. Although Play does not fully adopt Akka Typed, we already provide some APIs to better integrate it in Play applications.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/working/commonGuide/assets/Assets.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Static assets

This section covers serving your application’s static resources such as JavaScript, CSS and images.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Using CoffeeScript

[CoffeeScript](https://coffeescript.org/) is a small and elegant language that compiles into JavaScript. It provides a nice syntax for writing JavaScript code.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Using JSHint

From its [website documentation](https://jshint.com/about/):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Using LESS CSS

[LESS CSS](http://lesscss.org/) is a dynamic stylesheet language. It allows considerable flexibility in the way you write CSS files including support for variables, mixins and more.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Working with public assets

Serving a public resource in Play is the same as serving any other HTTP request. It uses the same routing as regular resources using the controller/action path to distribute CSS, JavaScript or image files to the client.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Using Sass

[Sass](https://sass-lang.com/) is a dynamic stylesheet language. It allows considerable flexibility in the way you write CSS files including support for variables, mixins and more.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# RequireJS

According to [RequireJS](https://requirejs.org/)' website
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Aggregating reverse routers

In some situations you want to share reverse routers between sub projects that are not dependent on each other.
Expand Down
1 change: 1 addition & 0 deletions documentation/manual/working/commonGuide/build/Build.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# The build system

This section gives details about Play's build system.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Overview of the build system

The Play build system uses [sbt](https://www.scala-sbt.org/), a high-performance integrated build for Scala and Java projects. Using `sbt` as our build tool brings certain requirements to play which are explained on this page.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Improving Compilation Times

Compilation speed can be improved by following some guidelines that are also good engineering practice:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# sbt Cookbook

## Hooking into Play's dev mode
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Copyright (C) Lightbend Inc. <https://www.lightbend.com> -->

# Debugging your build

If you are having difficulties getting sbt to do what you want it to do, you may need to use some of the built in utilities that sbt provides to help you debug your build.
Expand Down