Skip to content

Commit 24f598a

Browse files
authored
Merge pull request #1 from rusty-celery/docs
Switch to mdBook
2 parents d471a76 + 617761b commit 24f598a

File tree

11 files changed

+39
-48
lines changed

11 files changed

+39
-48
lines changed

β€Ž.github/workflows/deploy.yml

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
1-
on: push
1+
on:
2+
push:
3+
branches:
4+
- code
25
name: Build and deploy on push
36
jobs:
4-
build:
5-
name: shalzz/zola-deploy-action
7+
publish:
68
runs-on: ubuntu-latest
79
steps:
8-
- uses: actions/checkout@master
9-
- name: shalzz/zola-deploy-action
10-
uses: shalzz/zola-deploy-action@master
11-
env:
12-
PAGES_BRANCH: master
13-
TOKEN: ${{ secrets.TOKEN }}
10+
- name: Checkout
11+
uses: actions/checkout@v1
12+
13+
- name: Install mdBook
14+
run: |
15+
wget 'https://github.com/rust-lang/mdBook/releases/download/v0.3.5/mdbook-v0.3.5-x86_64-unknown-linux-gnu.tar.gz' --output-document 'mdbook.tar.gz'
16+
tar -zxvf mdbook.tar.gz
17+
18+
- name: Build
19+
run: mdbook
20+
21+
- name: Deploy
22+
if: success()
23+
uses: crazy-max/ghaction-github-pages@v1
24+
with:
25+
target_branch: master
26+
build_dir: book
27+
env:
28+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29+
GITHUB_PAC: ${{ secrets.TOKEN }}

β€Ž.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
public/
1+
book

β€Ž.gitmodules

Lines changed: 0 additions & 3 deletions
This file was deleted.

β€ŽREADME.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Rusty Celery Book
2+
3+
This repo contains the code for generating the guide book for Rusty Celery. It uses [mdBook](https://github.com/rust-lang/mdBook). Deployments are triggered through GitHub actions on pushes to this branch.

β€Žbook.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[book]
2+
authors = ["epwalsh"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "Rusty Celery"

β€Žconfig.toml

Lines changed: 0 additions & 17 deletions
This file was deleted.

β€Žcontent/_index.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

β€Žcontent/introduction/_index.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

β€Žsrc/SUMMARY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Summary
2+
3+
- [Chapter 1](./chapter_1.md)

β€Žsrc/chapter_1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Chapter 1

β€Žthemes/book

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
Β (0)