add an mdbook

This commit is contained in:
Dustin J. Mitchell 2020-11-21 19:41:36 -05:00
parent 1e28289b8b
commit ae8872d51e
6 changed files with 40 additions and 0 deletions

View file

@ -44,3 +44,30 @@ tasks:
description: Run tests for taskchampion
owner: dustin@v.igoro.us
source: ${repo_url}
- $if: run
then:
provisionerId: 'proj-misc'
workerType: 'ci'
deadline: {$fromNow: '1 hour'}
expires: {$fromNow: '1 day'}
payload:
maxRunTime: 3600
image: rust:latest
command:
- /bin/bash
- '-c'
- >-
git clone ${repo_url} repo &&
cd repo &&
git config advice.detachedHead false &&
git checkout ${ref} &&
cd docs &&
curl -L --compressed https://github.com/rust-lang/mdBook/releases/download/v0.4.4/mdbook-v0.4.4-x86_64-unknown-linux-gnu.tar.gz | gunzip -c | tar -xf - &&
chmod +x mdbook &&
./mdbook test &&
./mdbook build
metadata:
name: taskchampion-book
description: Verify that the docs build with mdbook
owner: dustin@v.igoro.us
source: ${repo_url}

1
docs/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
book

3
docs/README.md Normal file
View file

@ -0,0 +1,3 @@
This is an [mdbook](https://rust-lang.github.io/mdBook/index.html) book.
Minor modifications can be made without installing the mdbook tool, as the content is simple Markdown.
Changes are verified on pull requests.

6
docs/book.toml Normal file
View file

@ -0,0 +1,6 @@
[book]
authors = ["Dustin J. Mitchell"]
language = "en"
multilingual = false
src = "src"
title = "TaskChampion"

3
docs/src/SUMMARY.md Normal file
View file

@ -0,0 +1,3 @@
# Summary
- [Development Notes](./development-notes.md)