Skip to content

Commit 51164fd

Browse files
committed
add more instructions
1 parent 880a132 commit 51164fd

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
1-
# test conversion of the obf website
1+
# conversion of the obf website to GitHub pages
22

3-
Exploring the migration of the OBF WP site to a static site generator
3+
Migration of the OBF WP site to a static site generator (Hugo)
44

5-
6-
## Running locally
5+
## Running hugo server locally
76

87
1. [Install hugo](https://gohugo.io/installation/)
9-
2. Run `hugo server` from the root folder of the project to get a local server that automatically rebuilds
8+
2. Clone the GH repo:
9+
git clone https://github.com/OBF/OBF.github.io
10+
3. Initialize hugo
11+
cd OBF.github.io
12+
git submodule init
13+
git submodule update
14+
4. Run `hugo server` from the root folder of the project to get a local server that automatically rebuilds
15+
hugo server &
16+
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:
19+
git checkout -b BRANCH_NAME
20+
git add FILES
21+
git commit -m "my changes"
22+
git push
23+
(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/
25+
1026

11-
## Steps taken
27+
## Steps taken to port content from old WP site
1228

1329
1. Create XML export of existing WP site with all pages & posts
1430
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`

0 commit comments

Comments
 (0)