Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: bump hugo and add instruction on how to run docs server locally #473

Merged
merged 2 commits into from
Nov 9, 2024
Merged

docs: bump hugo and add instruction on how to run docs server locally #473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d3ce24
docs: bump hugo version to 0.120.4
alcpereira Nov 6, 2024
9862c26
docs: add running docs instruction to CONTRIBUTING
alcpereira Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/hugo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.111.3
HUGO_VERSION: 0.120.4
steps:
- name: Install Hugo CLI
run: |
Expand Down
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,15 @@ import "log"
log.Printf("Some message with a variable %v\n", someVariable)
```

### Running the docs locally

- Check the current Hugo version in the [workflow file](./.github/workflows/hugo.yaml)
- Install correct Hugo Extended version using the [official installation guide](https://gohugo.io/getting-started/installing/)
- Check the Hugo version using `hugo version`
- Go to the `docs/` directory using `cd docs`
- Install the Hugo mods using `hugo mod get`
- Run the Hugo server using `hugo server`

### Your PR is merged!

Congratulations :tada::tada:
4 changes: 2 additions & 2 deletions docs/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ module github.com/dlvhdr/gh-dash/docs
go 1.19

require (
github.com/platenio/platen/modules/platen v0.0.0-20230614143927-dd048e2da196 // indirect
github.com/platenio/platen/modules/schematize v0.0.0-20230614143927-dd048e2da196 // indirect
github.com/platenio/platen/modules/platen v0.0.0-20231124141037-5a875309774c // indirect
github.com/platenio/platen/modules/schematize v0.0.0-20231124141037-5a875309774c // indirect
)
4 changes: 4 additions & 0 deletions docs/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ github.com/platenio/platen/modules/platen v0.0.0-20230530030614-0a5bf77211cc h1:
github.com/platenio/platen/modules/platen v0.0.0-20230530030614-0a5bf77211cc/go.mod h1:7pfizXCKb4vonp6Og/3zkoy09YYsHip9/hXiT/pc3IM=
github.com/platenio/platen/modules/platen v0.0.0-20230614143927-dd048e2da196 h1:rSOUejTdKH6VGNCMFn2ti9MhGOcFj+PvnDuYibJoakk=
github.com/platenio/platen/modules/platen v0.0.0-20230614143927-dd048e2da196/go.mod h1:7pfizXCKb4vonp6Og/3zkoy09YYsHip9/hXiT/pc3IM=
github.com/platenio/platen/modules/platen v0.0.0-20231124141037-5a875309774c h1:ftQLeFf3erlZrGq/3RGkwglSBT/sq9Xz8tYfi14LQdM=
github.com/platenio/platen/modules/platen v0.0.0-20231124141037-5a875309774c/go.mod h1:7pfizXCKb4vonp6Og/3zkoy09YYsHip9/hXiT/pc3IM=
github.com/platenio/platen/modules/schematize v0.0.0-20230417130935-f8a3fca1013d h1:PhpSZzd1YFHCZzsJJinIHoMU3Bw/w/GPYkWXz/flnvU=
github.com/platenio/platen/modules/schematize v0.0.0-20230417130935-f8a3fca1013d/go.mod h1:0u7RXHeXIfNq9mAGzEu5T0UxdAa9D54y+ucI8oivs5M=
github.com/platenio/platen/modules/schematize v0.0.0-20230504053552-c70b34ba1161 h1:t0wxjK59xg5ggSEpWEZHtooO0COoV5oC/WFIPcJLhRM=
Expand All @@ -18,3 +20,5 @@ github.com/platenio/platen/modules/schematize v0.0.0-20230530030614-0a5bf77211cc
github.com/platenio/platen/modules/schematize v0.0.0-20230530030614-0a5bf77211cc/go.mod h1:0u7RXHeXIfNq9mAGzEu5T0UxdAa9D54y+ucI8oivs5M=
github.com/platenio/platen/modules/schematize v0.0.0-20230614143927-dd048e2da196 h1:p4GUmZTuMEdDkhLG8V7Eo+YY8DVWR4h872Ohd1HqPRI=
github.com/platenio/platen/modules/schematize v0.0.0-20230614143927-dd048e2da196/go.mod h1:0u7RXHeXIfNq9mAGzEu5T0UxdAa9D54y+ucI8oivs5M=
github.com/platenio/platen/modules/schematize v0.0.0-20231124141037-5a875309774c h1:07Pq498bWcMqztKpHoo/fhst9QQeM/Qza6dySzhc9kU=
github.com/platenio/platen/modules/schematize v0.0.0-20231124141037-5a875309774c/go.mod h1:0u7RXHeXIfNq9mAGzEu5T0UxdAa9D54y+ucI8oivs5M=
Loading