Skip to content

Commit 2d7100b

Browse files
committed
modify instructions
1 parent 51164fd commit 2d7100b

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,33 @@ Migration of the OBF WP site to a static site generator (Hugo)
66

77
1. [Install hugo](https://gohugo.io/installation/)
88
2. Clone the GH repo:
9+
```
910
git clone https://github.com/OBF/OBF.github.io
11+
```
1012
3. Initialize hugo
13+
```
1114
cd OBF.github.io
1215
git submodule init
1316
git submodule update
14-
4. Run `hugo server` from the root folder of the project to get a local server that automatically rebuilds
17+
```
18+
4. Run `hugo server` from the root folder of the project to get a
19+
local server that automatically rebuilds:
20+
```
1521
hugo server &
22+
```
1623
5. View the site in your web browser by going to [http://localhost:1313/](http://localhost:1313/)
17-
6. When you edit stuff, you should be able to reload http://localhost:1313/ to instantly see the changes!
18-
7. To push your changes back to the live site, remember to commit them:
24+
6. When you make changes, you should be able to reload http://localhost:1313/ to instantly see the changes!
25+
7. To push your changes back to the live site, remember to commit
26+
them. First you will need a
27+
[GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). Then do:
28+
```
1929
git checkout -b BRANCH_NAME
2030
git add FILES
2131
git commit -m "my changes"
22-
git push
32+
git push (or you might need to do git push --set-upstream origin BRANCH_NAME)
33+
```
2334
(Then go to https://github.com/OBF/OBF.github.io to make a PR)
24-
8. Once the PR is merged, your changes should be visible on https://obf.github.io/
35+
8. Once the PR is merged, your changes should be visible on [https://obf.github.io/](https://obf.github.io/)
2536

2637

2738
## Steps taken to port content from old WP site

0 commit comments

Comments
 (0)