Deploy docs site with Hugo via GitHub Actions #257
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: Deploy to GitHub Pages | ||
|
|
||
| on: | ||
| push: | ||
| branches: ["main"] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: {} | ||
|
|
||
| concurrency: | ||
| group: pages | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build-and-deploy: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| persist-credentials: true | ||
|
|
||
| - name: Setup mise | ||
| uses: jdx/mise-action@6d1e696aa24c1aa1bcc1adea0212707c71ab78a8 # v3.6.1 | ||
| with: | ||
| cache: true | ||
|
|
||
| - name: Build docs | ||
| run: mise run build-docs | ||
|
|
||
| - name: Push rendered site to gh-pages | ||
| uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./docs/public | ||
| publish_branch: gh-pages | ||
| keep_files: true | ||
| user_name: "github-actions[bot]" | ||
| user_email: "41898282+github-actions[bot]@users.noreply.github.com" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| _site | ||
| .gh-pages | ||
| .idea | ||
| docs/.hugo_build.lock | ||
| docs/public/ | ||
| .php_cs.cache | ||
| .php-cs-fixer.cache | ||
| .phpunit.cache/ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -170,19 +170,6 @@ php phpDocumentor.phar \ | |
|
|
||
| rm -rf "$cachedir" | ||
|
|
||
| git add doc/ | ||
|
|
||
| echo "Release notes for $tag:" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| baseURL = "https://maxmind.github.io/minfraud-api-php/" | ||
| title = "minFraud PHP API" | ||
| disableKinds = ["taxonomy"] | ||
|
|
||
| [[cascade]] | ||
| layout = "default" | ||
|
|
||
| [markup.highlight] | ||
| noClasses = true | ||
| style = "github" | ||
|
|
||
| [[module.mounts]] | ||
| source = "../README.md" | ||
| target = "content/_index.md" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| <h{{ .Level }} id="{{ .Anchor }}"> | ||
| {{- .Text | safeHTML -}} | ||
| <a class="heading-anchor" href="#{{ .Anchor }}" aria-label="Link to {{ .PlainText }}">#</a> | ||
| </h{{ .Level }}> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <title>{{ if .IsHome }}{{ .Site.Title }}{{ else }}{{ or .Title .File.BaseFileName }} | {{ .Site.Title }}{{ end }}</title> | ||
| <style> | ||
| :root { | ||
| --fg: #2d2d2d; | ||
| --bg: #faf9f7; | ||
| --accent: #1a6b50; | ||
| --accent-soft: rgba(26, 107, 80, 0.06); | ||
| --border: #d5d0c8; | ||
| --code-bg: #f0eeea; | ||
| --heading: #1a1a1a; | ||
| --muted: #70695f; | ||
| } | ||
|
|
||
| ::selection { | ||
| background: rgba(26, 107, 80, 0.15); | ||
| } | ||
|
|
||
| *, | ||
| *::before, | ||
| *::after { | ||
| box-sizing: border-box; | ||
| } | ||
|
|
||
| body { | ||
| font-family: Charter, "Bitstream Charter", "Sitka Text", Cambria, serif; | ||
| font-size: 1.05rem; | ||
| line-height: 1.78; | ||
| color: var(--fg); | ||
| background: var(--bg); | ||
| max-width: 50rem; | ||
| margin: 0 auto; | ||
| padding: 3rem 1.5rem 5rem; | ||
| } | ||
|
|
||
| h1, | ||
| h2, | ||
| h3, | ||
| h4 { | ||
| font-family: system-ui, -apple-system, "Segoe UI", Helvetica, Arial, | ||
| sans-serif; | ||
| line-height: 1.35; | ||
| } | ||
|
|
||
| h1 { | ||
| font-size: 1.75rem; | ||
| font-weight: 800; | ||
| color: var(--heading); | ||
| margin: 0 0 1.5rem; | ||
| padding-bottom: 0.75rem; | ||
| border-bottom: 3px solid var(--accent); | ||
| } | ||
|
|
||
| h2 { | ||
| font-size: 1.3rem; | ||
| font-weight: 700; | ||
| color: var(--heading); | ||
| margin: 3rem 0 0.75rem; | ||
| padding-bottom: 0.4rem; | ||
| border-bottom: 1px solid var(--border); | ||
| } | ||
|
|
||
| h3 { | ||
| font-size: 1.05rem; | ||
| font-weight: 700; | ||
| color: var(--accent); | ||
| margin: 2.5rem 0 0.5rem; | ||
| padding: 0.4rem 0.75rem; | ||
| border-left: 3px solid var(--accent); | ||
| background: linear-gradient( | ||
| 135deg, | ||
| var(--accent-soft), | ||
| transparent 80% | ||
| ); | ||
| border-radius: 0 3px 3px 0; | ||
| } | ||
|
|
||
| h4 { | ||
| font-size: 0.92rem; | ||
| font-weight: 700; | ||
| color: var(--muted); | ||
| margin: 2rem 0 0.5rem; | ||
| padding-bottom: 0.2rem; | ||
| border-bottom: 1px dashed var(--border); | ||
| } | ||
|
|
||
| p { | ||
| margin: 0.8rem 0; | ||
| } | ||
|
|
||
| a { | ||
| color: var(--accent); | ||
| text-decoration-thickness: 1px; | ||
| text-underline-offset: 2px; | ||
| transition: text-decoration-thickness 0.15s; | ||
| } | ||
|
|
||
| a:hover { | ||
| text-decoration-thickness: 2px; | ||
| } | ||
|
|
||
| strong { | ||
| color: var(--heading); | ||
| font-weight: 700; | ||
| } | ||
|
|
||
| ol, | ||
| ul { | ||
| padding-left: 1.75rem; | ||
| } | ||
|
|
||
| li + li { | ||
| margin-top: 0.3rem; | ||
| } | ||
|
|
||
| code { | ||
| font-family: "JetBrains Mono", "Cascadia Code", Menlo, Consolas, | ||
| monospace; | ||
| font-size: 0.88em; | ||
| background: var(--code-bg); | ||
| padding: 0.15em 0.4em; | ||
| border-radius: 3px; | ||
| border: 1px solid rgba(0, 0, 0, 0.06); | ||
| } | ||
|
|
||
| pre { | ||
| background: var(--code-bg); | ||
| border: 1px solid var(--border); | ||
| border-radius: 5px; | ||
| padding: 1rem 1.25rem; | ||
| overflow-x: auto; | ||
| line-height: 1.55; | ||
| } | ||
|
|
||
| pre code { | ||
| background: none; | ||
| padding: 0; | ||
| border: none; | ||
| font-size: 0.85em; | ||
| } | ||
|
|
||
| .heading-anchor { | ||
| opacity: 0; | ||
| margin-left: 0.3em; | ||
| font-weight: 400; | ||
| text-decoration: none; | ||
| transition: opacity 0.15s; | ||
| } | ||
|
|
||
| h1:hover .heading-anchor, | ||
| h2:hover .heading-anchor, | ||
| h3:hover .heading-anchor, | ||
| h4:hover .heading-anchor, | ||
| .heading-anchor:focus { | ||
| opacity: 0.4; | ||
| } | ||
|
|
||
| .heading-anchor:hover { | ||
| opacity: 1; | ||
| } | ||
|
|
||
| .page-nav { | ||
| margin-bottom: 2.5rem; | ||
| display: flex; | ||
| gap: 0.5rem; | ||
| flex-wrap: wrap; | ||
| } | ||
|
|
||
| .page-nav a { | ||
| font-family: system-ui, -apple-system, "Segoe UI", Helvetica, Arial, | ||
| sans-serif; | ||
| font-size: 0.85rem; | ||
| font-weight: 600; | ||
| text-decoration: none; | ||
| color: var(--muted); | ||
| padding: 0.3rem 0.75rem; | ||
| border: 1px solid var(--border); | ||
| border-radius: 999px; | ||
| transition: color 0.15s, border-color 0.15s, background 0.15s; | ||
| } | ||
|
|
||
| .page-nav a:hover { | ||
| color: var(--accent); | ||
| border-color: var(--accent); | ||
| } | ||
|
|
||
| .page-nav a.active { | ||
| color: var(--bg); | ||
| background: var(--accent); | ||
| border-color: var(--accent); | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <nav class="page-nav"> | ||
| <a href="{{ .Site.Home.RelPermalink }}"{{ if .IsHome }} class="active"{{ end }}>Overview</a> | ||
| <a href="{{ "doc/latest/" | relURL }}">API documentation</a> | ||
| </nav> | ||
| <main> | ||
| {{ .Content }} | ||
| </main> | ||
| </body> | ||
| </html> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # @generated - this file is auto-generated by `mise lock` https://mise.jdx.dev/dev-tools/mise-lock.html | ||
|
|
||
| [[tools.hugo]] | ||
| version = "0.161.1" | ||
| backend = "aqua:gohugoio/hugo" | ||
|
|
||
| [tools.hugo."platforms.linux-arm64"] | ||
| checksum = "sha256:382371ec3208236fb854ced51781f859b6c27a7d066b8fe90594eba14ba76d00" | ||
| url = "https://github.com/gohugoio/hugo/releases/download/v0.161.1/hugo_0.161.1_linux-arm64.tar.gz" | ||
|
|
||
| [tools.hugo."platforms.linux-arm64-musl"] | ||
| checksum = "sha256:382371ec3208236fb854ced51781f859b6c27a7d066b8fe90594eba14ba76d00" | ||
| url = "https://github.com/gohugoio/hugo/releases/download/v0.161.1/hugo_0.161.1_linux-arm64.tar.gz" | ||
|
|
||
| [tools.hugo."platforms.linux-x64"] | ||
| checksum = "sha256:fae28bf7909c1a42d1365b89d2e9e3d4194fbe5968ae0dd5504f562381018a1d" | ||
| url = "https://github.com/gohugoio/hugo/releases/download/v0.161.1/hugo_0.161.1_linux-amd64.tar.gz" | ||
|
|
||
| [tools.hugo."platforms.linux-x64-musl"] | ||
| checksum = "sha256:fae28bf7909c1a42d1365b89d2e9e3d4194fbe5968ae0dd5504f562381018a1d" | ||
| url = "https://github.com/gohugoio/hugo/releases/download/v0.161.1/hugo_0.161.1_linux-amd64.tar.gz" | ||
|
|
||
| [tools.hugo."platforms.macos-arm64"] | ||
| checksum = "sha256:b12e1cbebacf61f9cf67e0046c835142e70c829da7c16b05c1ec64a68885ee80" | ||
| url = "https://github.com/gohugoio/hugo/releases/download/v0.161.1/hugo_0.161.1_darwin-universal.pkg" | ||
|
|
||
| [tools.hugo."platforms.macos-x64"] | ||
| checksum = "sha256:b12e1cbebacf61f9cf67e0046c835142e70c829da7c16b05c1ec64a68885ee80" | ||
| url = "https://github.com/gohugoio/hugo/releases/download/v0.161.1/hugo_0.161.1_darwin-universal.pkg" | ||
|
|
||
| [tools.hugo."platforms.windows-x64"] | ||
| checksum = "sha256:7f8d030b37600c60bf2a782611257e6a768934fbe7724c1f3a1a501e6724cf0d" | ||
| url = "https://github.com/gohugoio/hugo/releases/download/v0.161.1/hugo_0.161.1_windows-amd64.zip" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,24 @@ | ||||||
| [settings] | ||||||
| lockfile = true | ||||||
| disable_backends = [ | ||||||
| "asdf", | ||||||
| "vfox", | ||||||
| ] | ||||||
|
|
||||||
| [tools] | ||||||
| hugo = "latest" | ||||||
|
|
||||||
| [hooks] | ||||||
| enter = "mise install --quiet" | ||||||
|
|
||||||
| [[watch_files]] | ||||||
| patterns = ["mise.toml", "mise.lock"] | ||||||
| run = "mise install --quiet" | ||||||
|
|
||||||
| [tasks.build-docs] | ||||||
| description = "Build the docs site with Hugo" | ||||||
| run = "hugo --source docs --minify" | ||||||
|
|
||||||
| [tasks.serve-docs] | ||||||
| description = "Serve the docs site locally with Hugo dev server" | ||||||
| run = "hugo server --source docs" | ||||||
|
There was a problem hiding this comment. The "API documentation" link in the template uses
Suggested change
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better accessibility, add
aria-current="page"to the active navigation link. This helps screen reader users identify the current page within the navigation menu.