diff --git a/README.md b/README.md index 3a65a287f..135f89164 100644 --- a/README.md +++ b/README.md @@ -24,5 +24,5 @@ There are three crates here: ## See Also - * [Documentation](docs/src/SUMMARY.md) (will be published as an mdbook eventually) + * [Documentation](https://djmitche.github.io/taskchampion/) (NOTE: temporary url) * [Progress on the first version](https://github.com/djmitche/taskwarrior-rust/projects/1) diff --git a/docs/.gitignore b/docs/.gitignore index 7585238ef..d2479eb14 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1 +1,2 @@ book +tmp diff --git a/docs/build.sh b/docs/build.sh new file mode 100755 index 000000000..06dc662c7 --- /dev/null +++ b/docs/build.sh @@ -0,0 +1,23 @@ +#! /bin/bash + +REMOTE=origin + +set -e + +if ! [ -f "./src/SUMMARY.md" ]; then + echo "Run this from the docs/ dir" + exit 1 +fi + +if ! [ -d ./tmp ]; then + git worktree add tmp gh-pages +fi + +(cd tmp && git pull $REMOTE gh-pages) + +rm -rf tmp/* +mdbook build +cp -rp book/* tmp +(cd tmp && git add -A) +(cd tmp && git commit -am "update docs") +(cd tmp && git push $REMOTE gh-pages:gh-pages) diff --git a/docs/src/usage.md b/docs/src/usage.md index 39a73fc03..e284815bd 100644 --- a/docs/src/usage.md +++ b/docs/src/usage.md @@ -2,3 +2,5 @@ The main interface to your tasks is the `task` command, which supports various subcommands. You can find a quick list of all subcommands with `task help`. + +Note that the `task` interface does not match that of TaskWarrior.