Skip to content

Commit 406c505

Browse files
committed
add book stub
1 parent a60ffc3 commit 406c505

File tree

5 files changed

+61
-0
lines changed

5 files changed

+61
-0
lines changed

.github/workflows/mdbook.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: deploy book
2+
3+
on:
4+
push:
5+
workflow_dispatch: ~
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
env:
20+
MDBOOK_VERSION: 0.4.47
21+
steps:
22+
- uses: actions/checkout@v4
23+
- name: Install mdBook
24+
run: |
25+
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
26+
rustup update
27+
cargo install --version ${MDBOOK_VERSION} mdbook
28+
29+
- name: Setup Pages
30+
id: pages
31+
uses: actions/configure-pages@v4
32+
33+
- name: Build with mdBook
34+
run: mdbook build
35+
36+
- name: Upload artifact
37+
uses: actions/upload-pages-artifact@v3
38+
with:
39+
path: ./book
40+
41+
deploy:
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
runs-on: ubuntu-latest
46+
needs: build
47+
steps:
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

.gitignore

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

book.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[book]
2+
authors = ["Rodrigo V. Honorato"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "HADDOCK3 User Manual"

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.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

0 commit comments

Comments
 (0)