Skip to content

Commit cc271c8

Browse files
committed
Update README.md
1 parent 11153fd commit cc271c8

1 file changed

Lines changed: 21 additions & 11 deletions

File tree

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,28 @@ Online JupyterBook for learning Linear Algebra
33

44
## Getting Started with Jupyterbook
55

6-
# 1. Install CLI (if not already)
7-
pip install "jupyter-book>=2.0.0"
6+
1. **Install CLI (if not already):**
7+
```bash
8+
pip install "jupyter-book>=2.0.0"
9+
```
810

9-
# 2. Create myst.yml
10-
jupyter book init
11+
2. **Create `myst.yml`:**
12+
```bash
13+
jupyter book init
14+
```
1115

12-
# 3. Add content (manually create files like intro.md, chapters/*.md, or .ipynb)
13-
# Then generate TOC:
14-
jupyter book init --write-toc
16+
3. **Add content** (manually create files like `intro.md`, `chapters/*.md`, or `.ipynb`).
1517

16-
# 4. Preview locally
17-
jupyter book start
18+
```bash
19+
jupyter book init --write-toc
20+
```
1821

19-
# 5. Add GitHub Pages CI
20-
jupyter book init --gh-pages
22+
4. **Preview locally:**
23+
```bash
24+
jupyter book start
25+
```
26+
27+
5. **Add GitHub Pages CI:**
28+
```bash
29+
jupyter book init --gh-pages
30+
```

0 commit comments

Comments
 (0)