diff --git a/README.md b/README.md
index f370f5db..0d06b02d 100644
--- a/README.md
+++ b/README.md
@@ -2,788 +2,12 @@
# Task - A task runner / simpler Make alternative written in Go
-> We recently released version 2.0.0 of Task. The Taskfile changed a bit.
-Please, check the [Taskfile versions](TASKFILE_VERSIONS.md) document to see
-what changed and how to upgrade.
-
Task is a simple tool that allows you to easily run development and build
tasks. Task is written in Golang, but can be used to develop any language.
It aims to be simpler and easier to use then [GNU Make][make].
-- [Installation](#installation)
- - [Go](#go)
- - [Homebrew](#homebrew)
- - [Snap](#snap)
- - [Binary](#binary)
-- [Usage](#usage)
- - [Environment](#environment)
- - [OS specific task](#os-specific-task)
- - [Task directory](#task-directory)
- - [Task dependencies](#task-dependencies)
- - [Calling another task](#calling-another-task)
- - [Prevent unnecessary work](#prevent-unnecessary-work)
- - [Variables](#variables)
- - [Dynamic variables](#dynamic-variables)
- - [Go's template engine](#gos-template-engine)
- - [Help](#help)
- - [Silent mode](#silent-mode)
- - [Dry run mode](#dry-run-mode)
- - [Ignore errors](#ignore-errors)
- - [Output syntax](#output-syntax)
- - [Watch tasks](#watch-tasks-experimental)
-- [Examples](#examples)
-- [Alternative task runners](#alternative-task-runners)
+---
-## Installation
-
-### Go
-
-If you have a [Golang][golang] environment setup, you can simply run:
-
-```bash
-go get -u -v github.com/go-task/task/cmd/task
-```
-
-### Homebrew
-
-If you're on macOS and have [Homebrew][homebrew] installed, getting Task is
-as simple as running:
-
-```bash
-brew install go-task/tap/go-task
-```
-
-### Snap
-
-Task is available for [Snapcraft][snapcraft], but keep in mind that your
-Linux distribution should allow classic confinement for Snaps to Task work
-right:
-
-```bash
-sudo snap install task
-```
-
-### Install script
-
-We also have a [install script][installscript], which is very useful on
-scanarios like CIs. Many thanks to [godownloader][godownloader] for easily
-generating this script.
-
-```bash
-curl -s https://raw.githubusercontent.com/go-task/task/master/install-task.sh | sh
-```
-
-### Binary
-
-Or you can download the binary from the [releases][releases] page and add to
-your `PATH`. DEB and RPM packages are also available.
-The `task_checksums.txt` file contains the sha256 checksum for each file.
-
-## Usage
-
-Create a file called `Taskfile.yml` in the root of your project.
-The `cmds` attribute should contain the commands of a task.
-The example below allows compiling a Go app and uses [Minify][minify] to concat
-and minify multiple CSS files into a single one.
-
-```yml
-version: '2'
-
-tasks:
- build:
- cmds:
- - go build -v -i main.go
-
- assets:
- cmds:
- - minify -o public/style.css src/css
-```
-
-Running the tasks is as simple as running:
-
-```bash
-task assets build
-```
-
-Task uses [github.com/mvdan/sh](https://github.com/mvdan/sh), a native Go sh
-interpreter. So you can write sh/bash commands and it will work even on
-Windows, where `sh` or `bash` are usually not available. Just remember any
-executable called must be available by the OS or in PATH.
-
-If you ommit a task name, "default" will be assumed.
-
-### Environment
-
-You can specify environment variables that are added when running a command:
-
-```yml
-version: '2'
-
-tasks:
- build:
- cmds:
- - echo $hallo
- env:
- hallo: welt
-```
-
-### OS specific task
-
-If you add a `Taskfile_{{GOOS}}.yml` you can override or amend your Taskfile
-based on the operating system.
-
-Example:
-
-Taskfile.yml:
-
-```yml
-version: '2'
-
-tasks:
- build:
- cmds:
- - echo "default"
-```
-
-Taskfile_linux.yml:
-
-```yml
-version: '2'
-
-tasks:
- build:
- cmds:
- - echo "linux"
-```
-
-Will print out `linux` and not `default`.
-
-Keep in mind that the version of the files should match. Also, when redefining
-a task the whole task is replaced, properties of the task are not merged.
-
-It's also possible to have an OS specific `Taskvars.yml` file, like
-`Taskvars_windows.yml`, `Taskfile_linux.yml`, or `Taskvars_darwin.yml`. See the
-[variables section](#variables) below.
-
-### Task directory
-
-By default, tasks will be executed in the directory where the Taskfile is
-located. But you can easily make the task run in another folder informing
-`dir`:
-
-```yml
-version: '2'
-
-tasks:
- serve:
- dir: public/www
- cmds:
- # run http server
- - caddy
-```
-
-### Task dependencies
-
-You may have tasks that depend on others. Just pointing them on `deps` will
-make them run automatically before running the parent task:
-
-```yml
-version: '2'
-
-tasks:
- build:
- deps: [assets]
- cmds:
- - go build -v -i main.go
-
- assets:
- cmds:
- - minify -o public/style.css src/css
-```
-
-In the above example, `assets` will always run right before `build` if you run
-`task build`.
-
-A task can have only dependencies and no commands to group tasks together:
-
-```yml
-version: '2'
-
-tasks:
- assets:
- deps: [js, css]
-
- js:
- cmds:
- - minify -o public/script.js src/js
-
- css:
- cmds:
- - minify -o public/style.css src/css
-```
-
-If there is more than one dependency, they always run in parallel for better
-performance.
-
-If you want to pass information to dependencies, you can do that the same
-manner as you would to [call another task](#calling-another-task):
-
-```yml
-version: '2'
-
-tasks:
- default:
- deps:
- - task: echo_sth
- vars: {TEXT: "before 1"}
- - task: echo_sth
- vars: {TEXT: "before 2"}
- cmds:
- - echo "after"
-
- echo_sth:
- cmds:
- - echo {{.TEXT}}
-```
-
-### Calling another task
-
-When a task has many dependencies, they are executed concurrently. This will
-often result in a faster build pipeline. But in some situations you may need
-to call other tasks serially. In this case, just use the following syntax:
-
-```yml
-version: '2'
-
-tasks:
- main-task:
- cmds:
- - task: task-to-be-called
- - task: another-task
- - echo "Both done"
-
- task-to-be-called:
- cmds:
- - echo "Task to be called"
-
- another-task:
- cmds:
- - echo "Another task"
-```
-
-Overriding variables in the called task is as simple as informing `vars`
-attribute:
-
-```yml
-version: '2'
-
-tasks:
- main-task:
- cmds:
- - task: write-file
- vars: {FILE: "hello.txt", CONTENT: "Hello!"}
- - task: write-file
- vars: {FILE: "world.txt", CONTENT: "World!"}
-
- write-file:
- cmds:
- - echo "{{.CONTENT}}" > {{.FILE}}
-```
-
-The above syntax is also supported in `deps`.
-
-### Prevent unnecessary work
-
-If a task generates something, you can inform Task the source and generated
-files, so Task will prevent to run them if not necessary.
-
-```yml
-version: '2'
-
-tasks:
- build:
- deps: [js, css]
- cmds:
- - go build -v -i main.go
-
- js:
- cmds:
- - minify -o public/script.js src/js
- sources:
- - src/js/**/*.js
- generates:
- - public/script.js
-
- css:
- cmds:
- - minify -o public/style.css src/css
- sources:
- - src/css/**/*.css
- generates:
- - public/style.css
-```
-
-`sources` and `generates` can be files or file patterns. When both are given,
-Task will compare the modification date/time of the files to determine if it's
-necessary to run the task. If not, it will just print a message like
-`Task "js" is up to date`.
-
-If you prefer this check to be made by the content of the files, instead of
-its timestamp, just set the `method` property to `checksum`.
-You will probably want to ignore the `.task` folder in your `.gitignore` file
-(It's there that Task stores the last checksum).
-
-```yml
-version: '2'
-
-tasks:
- build:
- cmds:
- - go build .
- sources:
- - ./*.go
- generates:
- - app{{exeExt}}
- method: checksum
-```
-
-> TIP: method `none` skips any validation and always run the task.
-
-Alternatively, you can inform a sequence of tests as `status`. If no error
-is returned (exit status 0), the task is considered up-to-date:
-
-```yml
-version: '2'
-
-tasks:
- generate-files:
- cmds:
- - mkdir directory
- - touch directory/file1.txt
- - touch directory/file2.txt
- # test existence of files
- status:
- - test -d directory
- - test -f directory/file1.txt
- - test -f directory/file2.txt
-```
-
-You can use `--force` or `-f` if you want to force a task to run even when
-up-to-date.
-
-Also, `task --status [tasks]...` will exit with a non-zero exit code if any of
-the tasks are not up-to-date.
-
-### Variables
-
-When doing interpolation of variables, Task will look for the below.
-They are listed below in order of importance (e.g. most important first):
-
-- Variables declared locally in the task
-- Variables given while calling a task from another.
- (See [Calling another task](#calling-another-task) above)
-- Variables declared in the `vars:` option in the `Taskfile`
-- Variables available in the `Taskvars.yml` file
-- Environment variables
-
-Example of sending parameters with environment variables:
-
-```bash
-$ TASK_VARIABLE=a-value task do-something
-```
-
-Since some shells don't support above syntax to set environment variables
-(Windows) tasks also accepts a similar style when not in the beginning of
-the command. Variables given in this form are only visible to the task called
-right before.
-
-```bash
-$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!"
-```
-
-Example of locally declared vars:
-
-```yml
-version: '2'
-
-tasks:
- print-var:
- cmds:
- echo "{{.VAR}}"
- vars:
- VAR: Hello!
-```
-
-Example of global vars in a `Taskfile.yml`:
-
-```yml
-version: '2'
-
-vars:
- GREETING: Hello from Taskfile!
-
-tasks:
- greet:
- cmds:
- - echo "{{.GREETING}}"
-```
-
-Example of `Taskvars.yml` file:
-
-```yml
-PROJECT_NAME: My Project
-DEV_MODE: production
-GIT_COMMIT: {sh: git log -n 1 --format=%h}
-```
-
-#### Variables expansion
-
-Variables are expanded 2 times by default. You can change that by setting the
-`expansions:` option. Change that will be necessary if you compose many
-variables together:
-
-```yml
-version: '2'
-
-expansions: 3
-
-vars:
- FOO: foo
- BAR: bar
- BAZ: baz
- FOOBAR: "{{.FOO}}{{.BAR}}"
- FOOBARBAZ: "{{.FOOBAR}}{{.BAZ}}"
-
-tasks:
- default:
- cmds:
- - echo "{{.FOOBARBAZ}}"
-```
-
-#### Dynamic variables
-
-The below syntax (`sh:` prop in a variable) is considered a dynamic variable.
-The value will be treated as a command and the output assigned. If there is one
-or more trailing newlines, the last newline will be trimmed.
-
-```yml
-version: '2'
-
-tasks:
- build:
- cmds:
- - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go
- vars:
- GIT_COMMIT:
- sh: git log -n 1 --format=%h
-```
-
-This works for all types of variables.
-
-### Go's template engine
-
-Task parse commands as [Go's template engine][gotemplate] before executing
-them. Variables are accessible through dot syntax (`.VARNAME`).
-
-All functions by the Go's [sprig lib](http://masterminds.github.io/sprig/)
-are available. The following example gets the current date in a given format:
-
-```yml
-version: '2'
-
-tasks:
- print-date:
- cmds:
- - echo {{now | date "2006-01-02"}}
-```
-
-Task also adds the following functions:
-
-- `OS`: Returns operating system. Possible values are "windows", "linux",
- "darwin" (macOS) and "freebsd".
-- `ARCH`: return the architecture Task was compiled to: "386", "amd64", "arm"
- or "s390x".
-- `splitLines`: Splits Unix (\n) and Windows (\r\n) styled newlines.
-- `catLines`: Replaces Unix (\n) and Windows (\r\n) styled newlines with a space.
-- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\`
- path format to `/`.
-- `fromSlash`: Oposite of `toSlash`. Does nothing on Unix, but on Windows
- converts a string from `\` path format to `/`.
-- `exeExt`: Returns the right executable extension for the current OS
- (`".exe"` for Windows, `""` for others).
-
-Example:
-
-```yml
-version: '2'
-
-tasks:
- print-os:
- cmds:
- - echo '{{OS}} {{ARCH}}'
- - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}'
- # This will be path/to/file on Unix but path\to\file on Windows
- - echo '{{fromSlash "path/to/file"}}'
- enumerated-file:
- vars:
- CONTENT: |
- foo
- bar
- cmds:
- - |
- cat << EOF > output.txt
- {{range $i, $line := .CONTENT | splitLines -}}
- {{printf "%3d" $i}}: {{$line}}
- {{end}}EOF
-```
-
-### Help
-
-Running `task --list` (or `task -l`) lists all tasks with a description.
-The following taskfile:
-
-```yml
-version: '2'
-
-tasks:
- build:
- desc: Build the go binary.
- cmds:
- - go build -v -i main.go
-
- test:
- desc: Run all the go tests.
- cmds:
- - go test -race ./...
-
- js:
- cmds:
- - minify -o public/script.js src/js
-
- css:
- cmds:
- - minify -o public/style.css src/css
-```
-
-would print the following output:
-
-```bash
-* build: Build the go binary.
-* test: Run all the go tests.
-```
-
-## Silent mode
-
-Silent mode disables echoing of commands before Task runs it.
-For the following Taskfile:
-
-```yml
-version: '2'
-
-tasks:
- echo:
- cmds:
- - echo "Print something"
-```
-
-Normally this will be print:
-
-```sh
-echo "Print something"
-Print something
-```
-
-With silent mode on, the below will be print instead:
-
-```sh
-Print something
-```
-
-There's three ways to enable silent mode:
-
-* At command level:
-
-```yml
-version: '2'
-
-tasks:
- echo:
- cmds:
- - cmd: echo "Print something"
- silent: true
-```
-
-* At task level:
-
-```yml
-version: '2'
-
-tasks:
- echo:
- cmds:
- - echo "Print something"
- silent: true
-```
-
-* Or globally with `--silent` or `-s` flag
-
-If you want to suppress stdout instead, just redirect a command to `/dev/null`:
-
-```yml
-version: '2'
-
-tasks:
- echo:
- cmds:
- - echo "This will print nothing" > /dev/null
-```
-
-## Dry run mode
-
-Dry run mode (`--dry`) compiles and steps through each task, printing the commands
-that would be run without executing them. This is useful for debugging your Taskfiles.
-
-## Ignore errors
-
-You have the option to ignore errors during command execution.
-Given the following Taskfile:
-
-```yml
-version: '2'
-
-tasks:
- echo:
- cmds:
- - exit 1
- - echo "Hello World"
-```
-
-Task will abort the execution after running `exit 1` because the status code `1` stands for `EXIT_FAILURE`.
-However it is possible to continue with execution using `ignore_error`:
-
-```yml
-version: '2'
-
-tasks:
- echo:
- cmds:
- - cmd: exit 1
- ignore_error: true
- - echo "Hello World"
-```
-
-`ignore_error` can also be set for a task, which mean errors will be supressed
-for all commands. But keep in mind this option won't propagate to other tasks
-called either by `deps` or `cmds`!
-
-## Output syntax
-
-By default, Task just redirect the STDOUT and STDERR of the running commands
-to the shell in real time. This is good for having live feedback for log
-printed by commands, but the output can become messy if you have multiple
-commands running at the same time and printing lots of stuff.
-
-To make this more customizable, there are currently three different output
-options you can choose:
-
-- `interleaved` (default)
-- `group`
-- `prefixed`
-
- To choose another one, just set it to root in the Taskfile:
-
- ```yml
-version: '2'
-
-output: 'group'
-
-tasks:
- # ...
- ```
-
- The `group` output will print the entire output of a command once, after it
- finishes, so you won't have live feedback for commands that take a long time
- to run.
-
- The `prefix` output will prefix every line printed by a command with
- `[task-name] ` as the prefix, but you can customize the prefix for a command
- with the `prefix:` attribute:
-
- ```yml
-version: '2'
-
-output: prefixed
-
-tasks:
- default:
- deps:
- - task: print
- vars: {TEXT: foo}
- - task: print
- vars: {TEXT: bar}
- - task: print
- vars: {TEXT: baz}
-
- print:
- cmds:
- - echo "{{.TEXT}}"
- prefix: "print-{{.TEXT}}"
- silent: true
-```
-
-```bash
-$ task default
-[print-foo] foo
-[print-bar] bar
-[print-baz] baz
-```
-
-## Watch tasks
-
-If you give a `--watch` or `-w` argument, task will watch for file changes
-and run the task again. This requires the `sources` attribute to be given,
-so task know which files to watch.
-
-## Examples
-
-The [go-task/examples][examples] intends to be a collection of Taskfiles for
-various use cases.
-(It still lacks many examples, though. Contributions are welcome).
-
-## Alternative task runners
-
-- YAML based:
- - [rliebz/tusk][tusk]
-- Go based:
- - [magefile/mage][mage]
-- Make based or similar:
- - [casey/just][just]
-
-### Sponsors
-
-[][opencollective]
-
-### Backers
-
-[][opencollective]
-
-### Contributors
-
-[][contributors]
+See [Taskfile.org](https://taskfile.org) for documentation.
[make]: https://www.gnu.org/software/make/
-[releases]: https://github.com/go-task/task/releases
-[golang]: https://golang.org/
-[gotemplate]: https://golang.org/pkg/text/template/
-[tusk]: https://github.com/rliebz/tusk
-[mage]: https://github.com/magefile/mage
-[just]: https://github.com/casey/just
-[sh]: https://github.com/mvdan/sh
-[minify]: https://github.com/tdewolff/minify/tree/master/cmd/minify
-[examples]: https://github.com/go-task/examples
-[snapcraft]: https://snapcraft.io/
-[homebrew]: https://brew.sh/
-[installscript]: https://github.com/go-task/task/blob/master/install-task.sh
-[godownloader]: https://github.com/goreleaser/godownloader
-[opencollective]: https://opencollective.com/task
-[contributors]: https://github.com/go-task/task/graphs/contributors
diff --git a/Taskfile.yml b/Taskfile.yml
index 90fa4869..b811cb66 100644
--- a/Taskfile.yml
+++ b/Taskfile.yml
@@ -79,3 +79,13 @@ tasks:
cmds:
- echo '{{.GO_PACKAGES}}'
silent: true
+
+ docs:install:
+ desc: Installs docsify to work the on the documentation site
+ cmds:
+ - npm install docsify-cli -g
+
+ docs:serve:
+ desc: Serves the documentation site locally
+ cmds:
+ - docsify serve docs
diff --git a/docs/.nojekyll b/docs/.nojekyll
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..9fe456da
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,11 @@
+# Task - A task runner / simpler Make alternative written in Go
+
+Task is a simple tool that allows you to easily run development and build
+tasks. Task is written in Golang, but can be used to develop any language.
+It aims to be simpler and easier to use then [GNU Make][make].
+
+---
+
+See [Installation](INSTALLATION) and [Getting Started](USAGE#getting-started).
+
+[make]: https://www.gnu.org/software/make/
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
new file mode 100644
index 00000000..72d096eb
--- /dev/null
+++ b/docs/_sidebar.md
@@ -0,0 +1,36 @@
+# [Installation](installation)
+
+- [Go](INSTALLATION#go)
+- [Homebrew](INSTALLATION#homebrew)
+- [Snap](INSTALLATION#snap)
+- [Binary](INSTALLATION#binary)
+- [Install script](INSTALLATION#install-script)
+
+# [Usage](usage)
+
+- [Getting started](USAGE#getting-started)
+- [Environment](USAGE#environment)
+- [OS specific task](USAGE#os-specific-task)
+- [Task directory](USAGE#task-directory)
+- [Task dependencies](USAGE#task-dependencies)
+- [Calling another task](USAGE#calling-another-task)
+- [Prevent unnecessary work](USAGE#prevent-unnecessary-work)
+- [Variables](USAGE#variables)
+ - [Dynamic variables](USAGE#dynamic-variables)
+- [Go's template engine](USAGE#gos-template-engine)
+- [Help](USAGE#help)
+- [Silent mode](USAGE#silent-mode)
+- [Dry run mode](USAGE#dry-run-mode)
+- [Ignore errors](USAGE#ignore-errors)
+- [Output syntax](USAGE#output-syntax)
+- [Watch tasks](USAGE#watch-tasks-experimental)
+
+# [Taskfile Versions](taskfile_versions)
+
+# [Examples](examples)
+
+# [Releasing Task](releasing_task)
+
+# [Alternative Task Runners](alternative_task_runners)
+
+# [Sponsors and Backers](sponsors_and_backers)
diff --git a/docs/alternative_task_runners.md b/docs/alternative_task_runners.md
new file mode 100644
index 00000000..a54283e2
--- /dev/null
+++ b/docs/alternative_task_runners.md
@@ -0,0 +1,17 @@
+# Alternative task runners
+
+## YAML based:
+
+- [rliebz/tusk][tusk]
+
+## Go based:
+
+- [magefile/mage][mage]
+
+## Make similar:
+
+- [casey/just][just]
+
+[tusk]: https://github.com/rliebz/tusk
+[mage]: https://github.com/magefile/mage
+[just]: https://github.com/casey/just
diff --git a/docs/examples.md b/docs/examples.md
new file mode 100644
index 00000000..f4bda2b5
--- /dev/null
+++ b/docs/examples.md
@@ -0,0 +1,7 @@
+# Examples
+
+The [go-task/examples][examples] intends to be a collection of Taskfiles for
+various use cases.
+(It still lacks many examples, though. Contributions are welcome).
+
+[examples]: https://github.com/go-task/examples
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 00000000..0a56b64e
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,27 @@
+
+
+
+
+ Document
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 00000000..5f814b4b
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,51 @@
+# Installation
+
+## Go
+
+If you have a [Golang][golang] environment setup, you can simply run:
+
+```bash
+go get -u -v github.com/go-task/task/cmd/task
+```
+
+## Homebrew
+
+If you're on macOS and have [Homebrew][homebrew] installed, getting Task is
+as simple as running:
+
+```bash
+brew install go-task/tap/go-task
+```
+
+## Snap
+
+Task is available for [Snapcraft][snapcraft], but keep in mind that your
+Linux distribution should allow classic confinement for Snaps to Task work
+right:
+
+```bash
+sudo snap install task
+```
+
+## Install script
+
+We also have a [install script][installscript], which is very useful on
+scanarios like CIs. Many thanks to [godownloader][godownloader] for easily
+generating this script.
+
+```bash
+curl -s https://raw.githubusercontent.com/go-task/task/master/install-task.sh | sh
+```
+
+## Binary
+
+Or you can download the binary from the [releases][releases] page and add to
+your `PATH`. DEB and RPM packages are also available.
+The `task_checksums.txt` file contains the sha256 checksum for each file.
+
+[golang]: https://golang.org/
+[snapcraft]: https://snapcraft.io/
+[homebrew]: https://brew.sh/
+[installscript]: https://github.com/go-task/task/blob/master/install-task.sh
+[releases]: https://github.com/go-task/task/releases
+[godownloader]: https://github.com/goreleaser/godownloader
diff --git a/RELEASING_TASK.md b/docs/releasing_task.md
similarity index 100%
rename from RELEASING_TASK.md
rename to docs/releasing_task.md
diff --git a/docs/sponsors_and_backers.md b/docs/sponsors_and_backers.md
new file mode 100644
index 00000000..6452b789
--- /dev/null
+++ b/docs/sponsors_and_backers.md
@@ -0,0 +1,16 @@
+# Sponsors and Backers
+
+## Sponsors
+
+[][opencollective]
+
+## Backers
+
+[][opencollective]
+
+## Contributors
+
+[][contributors]
+
+[opencollective]: https://opencollective.com/task
+[contributors]: https://github.com/go-task/task/graphs/contributors
diff --git a/TASKFILE_VERSIONS.md b/docs/taskfile_versions.md
similarity index 94%
rename from TASKFILE_VERSIONS.md
rename to docs/taskfile_versions.md
index 00ab3cd1..997334a7 100644
--- a/TASKFILE_VERSIONS.md
+++ b/docs/taskfile_versions.md
@@ -1,9 +1,9 @@
-# Taskfile version
+# Taskfile Versions
The Taskfile syntax and features changed with time. This document explains what
changed on each version and how to upgrade your Taskfile.
-# What the Taskfile version mean
+## What the Taskfile version mean
The Taskfile version follows the Task version. E.g. the change to Taskfile
version `2` means that Task `v2.0.0` should be release to support it.
@@ -18,7 +18,7 @@ available, but not `3.0.0+`.
In the first version of the `Taskfile`, the `version:` key was not available,
because the tasks was in the root of the YAML document. Like this:
-```yml
+```yaml
echo:
cmds:
- echo "Hello, World!"
@@ -37,7 +37,7 @@ At version 2, we introduced the `version:` key, to allow us to envolve Task
with new features without breaking existing Taskfiles. The new syntax is as
follows:
-```yml
+```yaml
version: '2'
tasks:
@@ -49,7 +49,7 @@ tasks:
Version 2 allows you to write global variables directly in the Taskfile,
if you don't want to create a `Taskvars.yml`:
-```yml
+```yaml
version: '2'
vars:
@@ -72,7 +72,7 @@ The variable priority order changed to the following:
A new global option was added to configure the number of variables expansions
(which default to 2):
-```yml
+```yaml
version: '2'
expansions: 3
@@ -96,7 +96,7 @@ Version 2.1 includes a global `output` option, to allow having more control
over how commands output are printed to the console
(see [documentation][output] for more info):
-```yml
+```yaml
version: '2'
output: prefixed
@@ -109,9 +109,9 @@ tasks:
```
From this version it's not also possible to ignore errors of a command or task
-(check documentatio [here][ignore_errors]):
+(check documentation [here][ignore_errors]):
-```yml
+```yaml
version: '2'
tasks:
diff --git a/docs/usage.md b/docs/usage.md
new file mode 100644
index 00000000..c5b2c0ea
--- /dev/null
+++ b/docs/usage.md
@@ -0,0 +1,669 @@
+# Usage
+
+## Getting started
+
+Create a file called `Taskfile.yml` in the root of your project.
+The `cmds` attribute should contain the commands of a task.
+The example below allows compiling a Go app and uses [Minify][minify] to concat
+and minify multiple CSS files into a single one.
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ cmds:
+ - go build -v -i main.go
+
+ assets:
+ cmds:
+ - minify -o public/style.css src/css
+```
+
+Running the tasks is as simple as running:
+
+```bash
+task assets build
+```
+
+Task uses [github.com/mvdan/sh](https://github.com/mvdan/sh), a native Go sh
+interpreter. So you can write sh/bash commands and it will work even on
+Windows, where `sh` or `bash` are usually not available. Just remember any
+executable called must be available by the OS or in PATH.
+
+If you ommit a task name, "default" will be assumed.
+
+### Environment
+
+You can specify environment variables that are added when running a command:
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ cmds:
+ - echo $hallo
+ env:
+ hallo: welt
+```
+
+### OS specific task
+
+If you add a `Taskfile_{{GOOS}}.yml` you can override or amend your Taskfile
+based on the operating system.
+
+Example:
+
+Taskfile.yml:
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ cmds:
+ - echo "default"
+```
+
+Taskfile_linux.yml:
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ cmds:
+ - echo "linux"
+```
+
+Will print out `linux` and not `default`.
+
+Keep in mind that the version of the files should match. Also, when redefining
+a task the whole task is replaced, properties of the task are not merged.
+
+It's also possible to have an OS specific `Taskvars.yml` file, like
+`Taskvars_windows.yml`, `Taskfile_linux.yml`, or `Taskvars_darwin.yml`. See the
+[variables section](#variables) below.
+
+### Task directory
+
+By default, tasks will be executed in the directory where the Taskfile is
+located. But you can easily make the task run in another folder informing
+`dir`:
+
+```yaml
+version: '2'
+
+tasks:
+ serve:
+ dir: public/www
+ cmds:
+ # run http server
+ - caddy
+```
+
+### Task dependencies
+
+You may have tasks that depend on others. Just pointing them on `deps` will
+make them run automatically before running the parent task:
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ deps: [assets]
+ cmds:
+ - go build -v -i main.go
+
+ assets:
+ cmds:
+ - minify -o public/style.css src/css
+```
+
+In the above example, `assets` will always run right before `build` if you run
+`task build`.
+
+A task can have only dependencies and no commands to group tasks together:
+
+```yaml
+version: '2'
+
+tasks:
+ assets:
+ deps: [js, css]
+
+ js:
+ cmds:
+ - minify -o public/script.js src/js
+
+ css:
+ cmds:
+ - minify -o public/style.css src/css
+```
+
+If there is more than one dependency, they always run in parallel for better
+performance.
+
+If you want to pass information to dependencies, you can do that the same
+manner as you would to [call another task](#calling-another-task):
+
+```yaml
+version: '2'
+
+tasks:
+ default:
+ deps:
+ - task: echo_sth
+ vars: {TEXT: "before 1"}
+ - task: echo_sth
+ vars: {TEXT: "before 2"}
+ cmds:
+ - echo "after"
+
+ echo_sth:
+ cmds:
+ - echo {{.TEXT}}
+```
+
+### Calling another task
+
+When a task has many dependencies, they are executed concurrently. This will
+often result in a faster build pipeline. But in some situations you may need
+to call other tasks serially. In this case, just use the following syntax:
+
+```yaml
+version: '2'
+
+tasks:
+ main-task:
+ cmds:
+ - task: task-to-be-called
+ - task: another-task
+ - echo "Both done"
+
+ task-to-be-called:
+ cmds:
+ - echo "Task to be called"
+
+ another-task:
+ cmds:
+ - echo "Another task"
+```
+
+Overriding variables in the called task is as simple as informing `vars`
+attribute:
+
+```yaml
+version: '2'
+
+tasks:
+ main-task:
+ cmds:
+ - task: write-file
+ vars: {FILE: "hello.txt", CONTENT: "Hello!"}
+ - task: write-file
+ vars: {FILE: "world.txt", CONTENT: "World!"}
+
+ write-file:
+ cmds:
+ - echo "{{.CONTENT}}" > {{.FILE}}
+```
+
+The above syntax is also supported in `deps`.
+
+### Prevent unnecessary work
+
+If a task generates something, you can inform Task the source and generated
+files, so Task will prevent to run them if not necessary.
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ deps: [js, css]
+ cmds:
+ - go build -v -i main.go
+
+ js:
+ cmds:
+ - minify -o public/script.js src/js
+ sources:
+ - src/js/**/*.js
+ generates:
+ - public/script.js
+
+ css:
+ cmds:
+ - minify -o public/style.css src/css
+ sources:
+ - src/css/**/*.css
+ generates:
+ - public/style.css
+```
+
+`sources` and `generates` can be files or file patterns. When both are given,
+Task will compare the modification date/time of the files to determine if it's
+necessary to run the task. If not, it will just print a message like
+`Task "js" is up to date`.
+
+If you prefer this check to be made by the content of the files, instead of
+its timestamp, just set the `method` property to `checksum`.
+You will probably want to ignore the `.task` folder in your `.gitignore` file
+(It's there that Task stores the last checksum).
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ cmds:
+ - go build .
+ sources:
+ - ./*.go
+ generates:
+ - app{{exeExt}}
+ method: checksum
+```
+
+> TIP: method `none` skips any validation and always run the task.
+
+Alternatively, you can inform a sequence of tests as `status`. If no error
+is returned (exit status 0), the task is considered up-to-date:
+
+```yaml
+version: '2'
+
+tasks:
+ generate-files:
+ cmds:
+ - mkdir directory
+ - touch directory/file1.txt
+ - touch directory/file2.txt
+ # test existence of files
+ status:
+ - test -d directory
+ - test -f directory/file1.txt
+ - test -f directory/file2.txt
+```
+
+You can use `--force` or `-f` if you want to force a task to run even when
+up-to-date.
+
+Also, `task --status [tasks]...` will exit with a non-zero exit code if any of
+the tasks are not up-to-date.
+
+### Variables
+
+When doing interpolation of variables, Task will look for the below.
+They are listed below in order of importance (e.g. most important first):
+
+- Variables declared locally in the task
+- Variables given while calling a task from another.
+ (See [Calling another task](#calling-another-task) above)
+- Variables declared in the `vars:` option in the `Taskfile`
+- Variables available in the `Taskvars.yml` file
+- Environment variables
+
+Example of sending parameters with environment variables:
+
+```bash
+$ TASK_VARIABLE=a-value task do-something
+```
+
+Since some shells don't support above syntax to set environment variables
+(Windows) tasks also accepts a similar style when not in the beginning of
+the command. Variables given in this form are only visible to the task called
+right before.
+
+```bash
+$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!"
+```
+
+Example of locally declared vars:
+
+```yaml
+version: '2'
+
+tasks:
+ print-var:
+ cmds:
+ echo "{{.VAR}}"
+ vars:
+ VAR: Hello!
+```
+
+Example of global vars in a `Taskfile.yml`:
+
+```yaml
+version: '2'
+
+vars:
+ GREETING: Hello from Taskfile!
+
+tasks:
+ greet:
+ cmds:
+ - echo "{{.GREETING}}"
+```
+
+Example of `Taskvars.yml` file:
+
+```yaml
+PROJECT_NAME: My Project
+DEV_MODE: production
+GIT_COMMIT: {sh: git log -n 1 --format=%h}
+```
+
+#### Variables expansion
+
+Variables are expanded 2 times by default. You can change that by setting the
+`expansions:` option. Change that will be necessary if you compose many
+variables together:
+
+```yaml
+version: '2'
+
+expansions: 3
+
+vars:
+ FOO: foo
+ BAR: bar
+ BAZ: baz
+ FOOBAR: "{{.FOO}}{{.BAR}}"
+ FOOBARBAZ: "{{.FOOBAR}}{{.BAZ}}"
+
+tasks:
+ default:
+ cmds:
+ - echo "{{.FOOBARBAZ}}"
+```
+
+#### Dynamic variables
+
+The below syntax (`sh:` prop in a variable) is considered a dynamic variable.
+The value will be treated as a command and the output assigned. If there is one
+or more trailing newlines, the last newline will be trimmed.
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ cmds:
+ - go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go
+ vars:
+ GIT_COMMIT:
+ sh: git log -n 1 --format=%h
+```
+
+This works for all types of variables.
+
+### Go's template engine
+
+Task parse commands as [Go's template engine][gotemplate] before executing
+them. Variables are accessible through dot syntax (`.VARNAME`).
+
+All functions by the Go's [sprig lib](http://masterminds.github.io/sprig/)
+are available. The following example gets the current date in a given format:
+
+```yaml
+version: '2'
+
+tasks:
+ print-date:
+ cmds:
+ - echo {{now | date "2006-01-02"}}
+```
+
+Task also adds the following functions:
+
+- `OS`: Returns operating system. Possible values are "windows", "linux",
+ "darwin" (macOS) and "freebsd".
+- `ARCH`: return the architecture Task was compiled to: "386", "amd64", "arm"
+ or "s390x".
+- `splitLines`: Splits Unix (\n) and Windows (\r\n) styled newlines.
+- `catLines`: Replaces Unix (\n) and Windows (\r\n) styled newlines with a space.
+- `toSlash`: Does nothing on Unix, but on Windows converts a string from `\`
+ path format to `/`.
+- `fromSlash`: Oposite of `toSlash`. Does nothing on Unix, but on Windows
+ converts a string from `\` path format to `/`.
+- `exeExt`: Returns the right executable extension for the current OS
+ (`".exe"` for Windows, `""` for others).
+
+Example:
+
+```yaml
+version: '2'
+
+tasks:
+ print-os:
+ cmds:
+ - echo '{{OS}} {{ARCH}}'
+ - echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}'
+ # This will be path/to/file on Unix but path\to\file on Windows
+ - echo '{{fromSlash "path/to/file"}}'
+ enumerated-file:
+ vars:
+ CONTENT: |
+ foo
+ bar
+ cmds:
+ - |
+ cat << EOF > output.txt
+ {{range $i, $line := .CONTENT | splitLines -}}
+ {{printf "%3d" $i}}: {{$line}}
+ {{end}}EOF
+```
+
+### Help
+
+Running `task --list` (or `task -l`) lists all tasks with a description.
+The following taskfile:
+
+```yaml
+version: '2'
+
+tasks:
+ build:
+ desc: Build the go binary.
+ cmds:
+ - go build -v -i main.go
+
+ test:
+ desc: Run all the go tests.
+ cmds:
+ - go test -race ./...
+
+ js:
+ cmds:
+ - minify -o public/script.js src/js
+
+ css:
+ cmds:
+ - minify -o public/style.css src/css
+```
+
+would print the following output:
+
+```bash
+* build: Build the go binary.
+* test: Run all the go tests.
+```
+
+## Silent mode
+
+Silent mode disables echoing of commands before Task runs it.
+For the following Taskfile:
+
+```yaml
+version: '2'
+
+tasks:
+ echo:
+ cmds:
+ - echo "Print something"
+```
+
+Normally this will be print:
+
+```sh
+echo "Print something"
+Print something
+```
+
+With silent mode on, the below will be print instead:
+
+```sh
+Print something
+```
+
+There's three ways to enable silent mode:
+
+* At command level:
+
+```yaml
+version: '2'
+
+tasks:
+ echo:
+ cmds:
+ - cmd: echo "Print something"
+ silent: true
+```
+
+* At task level:
+
+```yaml
+version: '2'
+
+tasks:
+ echo:
+ cmds:
+ - echo "Print something"
+ silent: true
+```
+
+* Or globally with `--silent` or `-s` flag
+
+If you want to suppress stdout instead, just redirect a command to `/dev/null`:
+
+```yaml
+version: '2'
+
+tasks:
+ echo:
+ cmds:
+ - echo "This will print nothing" > /dev/null
+```
+
+## Dry run mode
+
+Dry run mode (`--dry`) compiles and steps through each task, printing the commands
+that would be run without executing them. This is useful for debugging your Taskfiles.
+
+## Ignore errors
+
+You have the option to ignore errors during command execution.
+Given the following Taskfile:
+
+```yaml
+version: '2'
+
+tasks:
+ echo:
+ cmds:
+ - exit 1
+ - echo "Hello World"
+```
+
+Task will abort the execution after running `exit 1` because the status code `1` stands for `EXIT_FAILURE`.
+However it is possible to continue with execution using `ignore_error`:
+
+```yaml
+version: '2'
+
+tasks:
+ echo:
+ cmds:
+ - cmd: exit 1
+ ignore_error: true
+ - echo "Hello World"
+```
+
+`ignore_error` can also be set for a task, which mean errors will be supressed
+for all commands. But keep in mind this option won't propagate to other tasks
+called either by `deps` or `cmds`!
+
+## Output syntax
+
+By default, Task just redirect the STDOUT and STDERR of the running commands
+to the shell in real time. This is good for having live feedback for log
+printed by commands, but the output can become messy if you have multiple
+commands running at the same time and printing lots of stuff.
+
+To make this more customizable, there are currently three different output
+options you can choose:
+
+- `interleaved` (default)
+- `group`
+- `prefixed`
+
+To choose another one, just set it to root in the Taskfile:
+
+```yaml
+version: '2'
+
+output: 'group'
+
+tasks:
+ # ...
+```
+
+ The `group` output will print the entire output of a command once, after it
+ finishes, so you won't have live feedback for commands that take a long time
+ to run.
+
+ The `prefix` output will prefix every line printed by a command with
+ `[task-name] ` as the prefix, but you can customize the prefix for a command
+ with the `prefix:` attribute:
+
+ ```yaml
+version: '2'
+
+output: prefixed
+
+tasks:
+ default:
+ deps:
+ - task: print
+ vars: {TEXT: foo}
+ - task: print
+ vars: {TEXT: bar}
+ - task: print
+ vars: {TEXT: baz}
+
+ print:
+ cmds:
+ - echo "{{.TEXT}}"
+ prefix: "print-{{.TEXT}}"
+ silent: true
+```
+
+```bash
+$ task default
+[print-foo] foo
+[print-bar] bar
+[print-baz] baz
+```
+
+## Watch tasks
+
+If you give a `--watch` or `-w` argument, task will watch for file changes
+and run the task again. This requires the `sources` attribute to be given,
+so task know which files to watch.
+
+[gotemplate]: https://golang.org/pkg/text/template/
+[minify]: https://github.com/tdewolff/minify/tree/master/cmd/minify