Skip to content

Commit 0b33f3d

Browse files
committed
Onboarding document to pages via workflow
1 parent 385b7ae commit 0b33f3d

4 files changed

Lines changed: 1220 additions & 0 deletions

File tree

.github/workflows/pages.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Deploy docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: actions/configure-pages@v5
24+
- uses: ruby/setup-ruby@v1
25+
with:
26+
ruby-version: '3.3'
27+
bundler-cache: true
28+
working-directory: docs
29+
- name: Build with Jekyll
30+
run: bundle exec jekyll build --source docs --destination _site
31+
- uses: actions/upload-pages-artifact@v3
32+
33+
deploy:
34+
needs: build
35+
runs-on: ubuntu-latest
36+
environment:
37+
name: github-pages
38+
url: ${{ steps.deployment.outputs.page_url }}
39+
steps:
40+
- id: deployment
41+
uses: actions/deploy-pages@v4

docs/_config.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
title: C++QED v3
2+
description: Framework for simulating open quantum dynamics
3+
theme: just-the-docs
4+
5+
url: https://vukics.github.io
6+
baseurl: /cppqed # the repo name, if it's not a user/org root page
7+
8+
# Navigation
9+
nav_sort: order # respect the order: field in front matter
10+
11+
# Search
12+
search_enabled: true
13+
14+
# Footer
15+
footer_content: "C++QED is developed at Wigner RCP. Distributed under the Boost Software License."
16+
17+
# Syntax highlighting
18+
color_scheme: nil # or "dark"
19+
20+
# Aux links in the top-right (e.g. back to GitHub)
21+
aux_links:
22+
"GitHub":
23+
- "https://github.com/vukics/cppqed"
24+
aux_links_new_tab: true

docs/_includes/head_custom.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<script>
2+
MathJax = { tex: { inlineMath: [['$', '$']] } };
3+
</script>
4+
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>

0 commit comments

Comments
 (0)