Skip to content

Commit 85aa070

Browse files
authored
Begin work on docs book (#156)
* init mdbook * Add workflow * trigger ci * fix install * re-trigger * fix typo * fix working dir * fix working dir
1 parent c76b062 commit 85aa070

File tree

6 files changed

+55
-0
lines changed

6 files changed

+55
-0
lines changed

.github/workflows/bevy_mod_scripting.yml

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ on:
88
- '.github/workflows/release-plz.yml'
99
- '.github/workflows/bevy_api_gen.yml'
1010
- '.github/workflows/macro_tests.yml'
11+
- 'docs/**'
1112

1213

1314
name: Check and Lint - bevy_mod_scripting

.github/workflows/mdbook.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Deploy mdBook to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- "**"
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/mdbook.yml'
10+
11+
jobs:
12+
13+
build:
14+
name: Build Book - mdbook
15+
runs-on: ubuntu-latest
16+
steps:
17+
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
21+
- uses: actions-rs/toolchain@v1
22+
with:
23+
toolchain: stable
24+
override: true
25+
- name: Rust Cache
26+
uses: Swatinem/[email protected]
27+
- name: Install mdBook
28+
run: cargo install mdbook
29+
30+
- name: Build the book
31+
run: cd docs && mdbook build
32+
33+
- name: Deploy to GitHub Pages
34+
if: github.ref == 'refs/heads/main'
35+
uses: peaceiris/actions-gh-pages@v3
36+
with:
37+
github_token: ${{ secrets.GITHUB_TOKEN }}
38+
publish_dir: docs/book

docs/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book

docs/book.toml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[book]
2+
authors = ["makspll"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "Bevy Scripting"

docs/src/SUMMARY.md

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

docs/src/chapter_1.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Chapter 1
2+
3+
4+
## Introduction
5+
6+
Welcome to the greatest documentation of all time WIP

0 commit comments

Comments
 (0)