Skip to content

Commit 672ab69

Browse files
committed
chore: add mdBook documentation and deploy workflow
1 parent f12c859 commit 672ab69

6 files changed

Lines changed: 35 additions & 0 deletions

File tree

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Deploy mdBook to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- name: Install mdBook
16+
run: cargo install mdbook
17+
18+
- name: Build the book
19+
run: mdbook build docs
20+
21+
- name: Deploy to GitHub Pages
22+
uses: peaceiris/actions-gh-pages@v3
23+
with:
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
publish_dir: ./docs/book

docs/.gitignore

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

docs/book.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[book]
2+
authors = ["Aliwi.Walid"]
3+
language = "en"
4+
src = "src"
5+
title = "Tockloader-rs Dev Notes"

docs/src/Introduction.md

Whitespace-only changes.

docs/src/Refrences.md

Whitespace-only changes.

docs/src/SUMMARY.md

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

0 commit comments

Comments
 (0)