Skip to content

Commit a9e54c8

Browse files
committed
adding mdbook
1 parent 5a4439f commit a9e54c8

File tree

5 files changed

+67
-0
lines changed

5 files changed

+67
-0
lines changed

.github/workflows/book.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Deploy mdBook site to Pages
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["master"]
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: false
22+
23+
jobs:
24+
# Build job
25+
build:
26+
runs-on: ubuntu-latest
27+
env:
28+
MDBOOK_VERSION: 0.4.36
29+
steps:
30+
- uses: actions/checkout@v4
31+
- name: Install mdBook
32+
run: |
33+
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
34+
rustup update
35+
cargo install --version ${MDBOOK_VERSION} mdbook
36+
- name: Setup Pages
37+
id: pages
38+
uses: actions/configure-pages@v5
39+
- name: Build with mdBook
40+
run: mdbook build
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: ./book
45+
46+
# Deployment job
47+
deploy:
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
runs-on: ubuntu-latest
52+
needs: build
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

book/.gitignore

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

book/book.toml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[book]
2+
authors = ["Chris Pecunies"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "dorm.lua"

book/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)

book/src/chapter_1.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Chapter 1

0 commit comments

Comments
 (0)