Skip to content

Commit 876ad5a

Browse files
committed
ADD initial layout using myst markdown for technical documentation
1 parent f96be0d commit 876ad5a

File tree

166 files changed

+11699
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+11699
-0
lines changed

.github/.workflow/deploy.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy MyST Book to GitHub Pages
2+
3+
on:
4+
# Trigger on every push to main
5+
push:
6+
branches: ["main"]
7+
# Allow manual triggers from the Actions tab
8+
workflow_dispatch:
9+
10+
# Sets permissions so the workflow can deploy to GitHub Pages
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
# Only allow one concurrent deployment; cancel in-flight runs
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout repository
26+
uses: actions/checkout@v4
27+
28+
- name: Set up Python 3.11
29+
uses: actions/setup-python@v5
30+
with:
31+
python-version: "3.11"
32+
cache: "pip"
33+
34+
- name: Install dependencies
35+
run: pip install -r requirements.txt
36+
37+
- name: Build Jupyter Book (MyST Markdown → HTML)
38+
run: jupyter-book build . --all
39+
40+
- name: Upload artifact for Pages
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: "./_build/html"
44+
45+
deploy:
46+
needs: build
47+
runs-on: ubuntu-latest
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

.gitignore

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

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# OpenLambda GitHub Pages — MyST Markdown Site
2+
3+
This repo deploys automatically to GitHub Pages using [Jupyter Book](https://jupyterbook.org)
4+
with [MyST Markdown](https://myst-parser.readthedocs.io/).
5+
6+
---
7+
8+
## File Structure
9+
10+
```
11+
.
12+
├── index.md ← Homepage content (MyST Markdown)
13+
├── _config.yml ← Jupyter Book site settings
14+
├── _toc.yml ← Table of contents (add more pages here)
15+
├── requirements.txt ← Python deps for the build
16+
├── .gitignore
17+
└── .github/
18+
└── workflows/
19+
└── deploy.yml ← GitHub Actions auto-deploy workflow
20+
```
21+
22+
---
23+
24+
## One-Time Setup (do this once per repo)
25+
26+
### 1. Clone the repo and copy these files in
27+
28+
```bash
29+
git clone https://github.com/open-lambda/open-lambda.github.io.git
30+
cd open-lambda.github.io
31+
32+
# Copy all files from this bundle into the repo root, then:
33+
git add .
34+
git commit -m "Add MyST Markdown Jupyter Book site"
35+
git push
36+
```
37+
38+
### 2. Enable GitHub Pages with GitHub Actions as the source
39+
40+
Go to the repo on GitHub:
41+
42+
1. **Settings****Pages** (left sidebar)
43+
2. Under **Source**, select **GitHub Actions** (not "Deploy from a branch")
44+
3. Save
45+
46+
That's it. Every push to `main` will now rebuild and redeploy the site automatically.
47+
48+
---
49+
50+
## Local Preview
51+
52+
```bash
53+
pip install -r requirements.txt
54+
jupyter-book build .
55+
# Open in browser:
56+
open _build/html/index.html
57+
```
58+
59+
---
60+
61+
## Adding More Pages
62+
63+
1. Create a new `.md` file, e.g. `worker.md`
64+
2. Add it to `_toc.yml`:
65+
66+
```yaml
67+
format: jb-book
68+
root: index
69+
chapters:
70+
- file: worker
71+
```
72+
73+
3. Push — the site rebuilds automatically.
74+
75+
---
76+
77+
## Troubleshooting
78+
79+
| Problem | Fix |
80+
|---|---|
81+
| Build fails: `jupyter-book not found` | Make sure `requirements.txt` lists `jupyter-book>=1.0.0` |
82+
| Pages shows 404 | Confirm **Settings → Pages → Source** is set to **GitHub Actions** |
83+
| Old content still showing | Hard-refresh browser (`Ctrl+Shift+R`) or wait ~1 min for CDN |
84+
| Action fails with permissions error | Go to **Settings → Actions → General → Workflow permissions** and enable "Read and write permissions" |

_build/.doctrees/README.doctree

15.9 KB
Binary file not shown.
28.3 KB
Binary file not shown.

_build/.doctrees/index.doctree

14.9 KB
Binary file not shown.

_build/html/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 00f39c391346115ca176ede8239be645
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

0 commit comments

Comments
 (0)