Skip to content

Commit 781fb21

Browse files
0.1.0 development
1 parent 3f8a1a9 commit 781fb21

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed
Loading
Loading

site/content/posts/hugo-github-pages-starter/index.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ This guide in particular uses a Tailwind CSS theme (ironically called [Tailwind]
3232
- Update your repos Settings/Pages to deploy using Github Actions and create a workflow using the provided `~/.github/workflows/hugo.yml` file
3333
- See the Hugo [Documentation](https://gohugo.io/host-and-deploy/host-on-github-pages/) for detailed instructions
3434
- Commit some changes and push to Main and your blog should now be available at https://username.github.io
35+
- (Optional) Apply any [Extras](#extras)
3536

3637
Supports Local, Docker Compose or GitHub Codespaces development.
3738

@@ -149,10 +150,11 @@ hugo-1 | Press Ctrl+C to stop
149150
Once you are happy with the setup, perform a git commit & push to save the files created by the Hugo new site initialization.
150151
</details>
151152

152-
#### Codespaces
153+
#### GitHub Codespaces
153154

154155
<details>
155156
<summary>Expand / Collapse</summary>
157+
156158
If you would prefer not to install anything at all locally, you can do *all* of your development these days on a machine in the cloud from the comfort of a web brower using [github codespaces](https://github.com/features/codespaces)
157159

158160
Note that this is also free, for up to 60 hours a month (as of the time this was written) which should be more than enough unless you are a blogging machine or using codespaces for other projects.
@@ -246,14 +248,14 @@ You may see an error on first setup as we haven't installed a theme yet, but we
246248

247249
From here click the top bar or press <kbd><kbd>CTRL</kbd>+<kbd>SHIFT</kbd>+<kbd>P</kbd></kbd> and select/type "Run Task" and then "Run Hugo Server" which should start up your Hugo server.
248250

249-
In the ports tab you can simply click the globe icon next to the forwarded port and that should open up an additional tab which will display your Hugo website.
251+
In the ports tab you can simply click the globe icon next to the forwarded port and that should open up an additional tab which will display your Hugo website. Once you are happy, make sure you perform a commit and push to sync the newly created site to your repo.
250252

251-
Once you are done, you can press <kbd><kbd>CTRL</kbd>+<kbd>SHIFT</kbd>+<kbd>P</kbd></kbd> and type "Stop current codespace" to stop the codespace, or just close the tab and then stop the codespace from the [codespaces](https://github.com/codespaces) page.
253+
> Note: Whenever you are done with developing, you can press <kbd><kbd>CTRL</kbd>+<kbd>SHIFT</kbd>+<kbd>P</kbd></kbd> and type "Stop current codespace" to stop the codespace, or just close the tab and then stop the codespace from the [codespaces](https://github.com/codespaces) page.
252254
</details>
253255
254256
### Tailwind theme installation
255257

256-
Now that your Hugo environment(s) is setup, you can install the Tailwind theme. To do this navigate to the root directory of our Hugo side (~/site) and add the Tailwind theme as a Git submodule
258+
Now that your Hugo development environment is setup, you can install the Tailwind theme. To do this navigate to the root directory of our Hugo site (~/site) and add the Tailwind theme as a Git submodule
257259

258260
```bash
259261
git submodule add https://github.com/tomowang/hugo-theme-tailwind.git themes/tailwind
@@ -446,9 +448,11 @@ Finally, update the "Upload artifact" step to also reference our /site directory
446448
447449
Commit and push these changes.
448450
449-
- Update your repos Settings/Pages to deploy using Github Actions and create a workflow using the `~/.github/workflows/hugo.yml` file
450-
- See the Hugo [Documentation](https://gohugo.io/host-and-deploy/host-on-github-pages/) for detailed instructions
451-
- Commit some changes and push to Main and your blog should now be available at https://username.github.io
451+
Now, in your repositories settings page, select the Pages section and change the Build and Deployment option source to to "GitHub Actions" and then select the "Deploy Hugo Site to Pages" workflow. Commit and Push another change and it should kick off the deployment action. You can view the progress and any failures
452+
453+
If everything went through successfully, your pages section should now look like the below
454+
455+
<img src="./images/hugo-pages-1.png" alt="GitHub settings screenshot">
452456
453457
## Extras
454458
@@ -493,3 +497,5 @@ Hugo and this theme support Google Analytics. To enable this create an account a
493497
ID = "G-XXXXXXXXXX"
494498
```
495499
500+
## Comments
501+

0 commit comments

Comments
 (0)