Skip to content

Commit 52da99c

Browse files
committed
docs: add GitBook documentation config with GitHub Pages CI
1 parent 3c06820 commit 52da99c

5 files changed

Lines changed: 78 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "docs/**"
8+
- "examples/*/README.md"
9+
- "README.md"
10+
- "README.zh.md"
11+
- "SUMMARY.md"
12+
- "CONTRIBUTING.md"
13+
- "CONTRIBUTING.zh.md"
14+
- "book.json"
15+
- ".github/workflows/docs.yml"
16+
workflow_dispatch:
17+
18+
permissions:
19+
contents: read
20+
pages: write
21+
id-token: write
22+
23+
concurrency:
24+
group: pages
25+
cancel-in-progress: true
26+
27+
jobs:
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v4
32+
33+
- uses: actions/setup-node@v4
34+
with:
35+
node-version: 20
36+
37+
- name: Install honkit
38+
run: npm install honkit
39+
40+
- name: Build docs
41+
run: npx honkit build . _site
42+
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: _site
47+
48+
deploy:
49+
needs: build
50+
runs-on: ubuntu-latest
51+
environment:
52+
name: github-pages
53+
url: ${{ steps.deployment.outputs.page_url }}
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@ docs/_build/
131131
docs/html/
132132
docs/latex/
133133
site/
134+
_site/
135+
_book/
134136

135137
# Backup files
136138
*.bak

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![Build](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/build.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white&label=Build)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/build.yml)
66
[![Benchmarks](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/benchmark.yml?branch=main&style=for-the-badge&logo=speedtest&logoColor=white&label=Benchmarks)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/benchmark.yml)
77
[![Sanitizers](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/sanitizers.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white&label=Sanitizers)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/sanitizers.yml)
8+
[![Docs](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/docs.yml?branch=main&style=for-the-badge&logo=githubpages&logoColor=white&label=Docs)](https://lessup.github.io/cpp-high-performance-guide/)
89

910
A comprehensive collection of high-performance computing optimization examples and best practices for modern C++20.
1011

README.zh.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![Build](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/build.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white&label=Build)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/build.yml)
66
[![Benchmarks](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/benchmark.yml?branch=main&style=for-the-badge&logo=speedtest&logoColor=white&label=Benchmarks)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/benchmark.yml)
77
[![Sanitizers](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/sanitizers.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white&label=Sanitizers)](https://github.com/LessUp/cpp-high-performance-guide/actions/workflows/sanitizers.yml)
8+
[![Docs](https://img.shields.io/github/actions/workflow/status/LessUp/cpp-high-performance-guide/docs.yml?branch=main&style=for-the-badge&logo=githubpages&logoColor=white&label=Docs)](https://lessup.github.io/cpp-high-performance-guide/)
89

910
面向现代 C++20 的高性能计算优化示例与最佳实践合集。
1011

book.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"title": "C++ High Performance Computing Optimization Guide",
3+
"description": "面向现代 C++20 的高性能计算优化示例与最佳实践合集",
4+
"language": "en",
5+
"gitbook": ">=3.2.0",
6+
"links": {
7+
"sidebar": {
8+
"GitHub": "https://github.com/LessUp/cpp-high-performance-guide"
9+
}
10+
},
11+
"plugins": [
12+
"-sharing",
13+
"-fontsettings",
14+
"theme-default"
15+
],
16+
"pluginsConfig": {}
17+
}

0 commit comments

Comments
 (0)