You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,8 @@ Migration of the OBF WP site to a static site generator (Hugo)
5
5
## Running hugo server locally
6
6
7
7
### Setting up a GitHub fork so you can make changes on your desktop
8
+
(Instructions for those who are not git gurus)
9
+
8
10
1. To make changes to web pages on your desktop and commit them from the command line to GH, you will need a
9
11
[GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
10
12
2. Go to https://github.com/OBF/OBF.github.io and make a fork
@@ -20,8 +22,18 @@ git commit -m "my changes"
20
22
git push (or you might need to do git push --set-upstream origin BRANCH_NAME)
21
23
```
22
24
23
-
4. Then go to https://github.com/YOUR_GITHUB_ID/OBF.github.io to make a PR
24
-
5. Once the PR is merged, your changes should be visible on [https://obf.github.io/](https://obf.github.io/)
25
+
5. Then go to https://github.com/YOUR_GITHUB_ID/OBF.github.io to make a PR
26
+
6. Once the PR is merged, your changes should be visible on
27
+
[https://obf.github.io/](https://obf.github.io/)
28
+
29
+
8. Next time you want to make more changes, first update your local
30
+
copy to pull in any changes others may have committed:
31
+
```
32
+
git checkout main
33
+
git pull
34
+
```
35
+
Then do the steps in #4 (with a new branch name) to commit your changes.
36
+
25
37
26
38
### Using hugo
27
39
0. Hugo documentation: https://gohugo.io/getting-started/quick-start/
@@ -44,3 +56,4 @@ hugo server &
44
56
1. Create XML export of existing WP site with all pages & posts
45
57
2. Run the conversion script [wp2hugo](https://github.com/ashishb/wp2hugo) in the following way `/wp2hugo -source obf.WordPress.2025-01-30.xml -output obf-test-hugo -download-media -continue-on-media-download-error`
46
58
3. update the `hugo.yaml` to use the correct base page (as currently not deployed on open-bio.org)
0 commit comments