Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mloning committed Dec 24, 2023
1 parent b47af17 commit d96a362
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages
name: Deploy

on:
workflow_dispatch:
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@ My personal website built with [Hugo] and a modified [ezhil] theme.

## Local development

* `git submodule update --init --recursive` to update the theme as a [git submodule]
* `gh repo clone https://github.com/mloning/website . -- --recurse-submodules` to clone the repo with the theme as a [git submodule]
* `git submodule update --init --recursive` to update the theme from the git submodule
* `hugo server --verbose --buildDrafts --buildFuture --navigateToChanged` to start the Hugo server with hot reloading
* `hugo new posts/<name>.md` to create a new draft in `content/posts/`

[git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules

## Deploy

Deployed to GitHub Pages using GitHub Actions.

Pushing changes to the `main` branch will trigger a deployment to [GitHub Pages] using a [GitHub Action].

[GitHub Pages]: https://mloning.github.io/website/
[GitHub Action]: https://github.com/mloning/website/actions/workflows/deploy.yaml

0 comments on commit d96a362

Please sign in to comment.