Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The documentation is built by the static-site-generator [Hugo](https://gohugo.io

Clone repository:
```shell
git clone --recurse-submodules git@github.com:cedardb/docs.git
git clone git@github.com:cedardb/docs.git
```

Run a web server:
Expand Down
2 changes: 1 addition & 1 deletion content/clients/psql.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ You can also show a list of all tables in the current database:
Most commands also have a more verbose variant with a `+` (e.g., `\d+`), which will show more details like the table
size in bytes.
For a full list of psql backslash commands, see the
[psql docs]((https://www.postgresql.org/docs/current/app-psql.html)).
[psql docs](https://www.postgresql.org/docs/current/app-psql.html).

## Using psql interactively

Expand Down
8 changes: 5 additions & 3 deletions themes/hextra/.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"features": {
"ghcr.io/devcontainers/features/hugo:1": {
"extended": true,
"version": "0.119.0"
"version": "0.147.7"
},
"ghcr.io/devcontainers/features/node:1": {}
},
Expand All @@ -18,5 +18,7 @@
}
},
"postCreateCommand": "npm install",
"forwardPorts": [1313]
}
"forwardPorts": [
1313
]
}
3 changes: 3 additions & 0 deletions themes/hextra/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Mark generated files so they are collapsed by default in GitHub diffs
assets/css/compiled/main.css linguist-generated=true
docs/hugo_stats.json linguist-generated=true
8 changes: 4 additions & 4 deletions themes/hextra/.github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Use [Conventional Commits][conventional commits] message to make it easier to un

Similar to contributing code, you can also contribute to the documentation by submitting a pull request.

The documentation site is located in the [`exampleSite`](../exampleSite/) folder.
The documentation site is located in the [`docs`](../docs/) folder.
You can make changes to the documentation and create a pull request. A preview of the new documentation will be automatically generated and displayed in the pull request comment via [Netlify][netlify deploy preview].

### 💬 GitHub Discussions
Expand All @@ -57,7 +57,7 @@ We recommend that you search existing [issues][issues] or discussions before ope

### Local development setup

- [Hugo][hugo] >= v0.115.0 (extended version)
- [Hugo][hugo] >= v0.124.0 (extended version)
- [Node.js][nodejs]
- [Go][go]

Expand All @@ -71,7 +71,7 @@ npm i

- [`assets`](../assets/): CSS styles and JavaScript files.
- [`data`](../data/): The theme data files. Now only contains the `icons.yaml` file.
- [`exampleSite`](../exampleSite/): The documentation site for the theme.
- [`docs`](../docs/): The documentation site for the theme.
- [`i18n`](../i18n/): The theme translation files.
- [`layouts`](../layouts/): The theme layouts.
- [`static`](../static/): The static files for the theme. For example, the favicon and the site logo.
Expand All @@ -84,7 +84,7 @@ Please refer to the [Hugo documentation][hugo] for more information.
npm run dev:theme
```

It will start the Hugo server on `http://localhost:1313/` for the `exampleSite` content.
It starts the Hugo server on `http://localhost:1313/` for the `docs` content.

### Compile the styles

Expand Down
15 changes: 15 additions & 0 deletions themes/hextra/.github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# These are supported funding model platforms

github: imfing
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
polar: # Replace with a single Polar username
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
thanks_dev: # Replace with a single thanks.dev username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
2 changes: 2 additions & 0 deletions themes/hextra/.github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ assignees: ''
2.
3.

<!-- Provide a minimal example or link to a repository that reproduces the bug -->

**Expected Behavior**

<!-- What should have happened? -->
Expand Down
46 changes: 27 additions & 19 deletions themes/hextra/.github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Sample workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages
# Build and deploy Hextra docs site to GitHub Pages
name: Deploy Hextra docs site to Pages

on:
# Runs on pushes targeting the default branch
Expand Down Expand Up @@ -31,35 +31,43 @@ jobs:
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.117.0
HUGO_VERSION: 0.156.0
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod
fetch-tags: true
submodules: recursive

- name: Setup Go
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: '1.20'
go-version: "1.26"

- name: Setup Pages
id: pages
uses: actions/configure-pages@v5

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: ${{ env.HUGO_VERSION }}
extended: true
- name: Build with Hugo
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb

- name: Make build script executable
run: chmod +x ./build.sh

- name: Build all site versions
env:
# For maximum backward compatibility with Hugo modules
HUGO_ENVIRONMENT: production
HUGO_ENV: production
run: |
hugo \
--minify \
--themesDir=../.. --source=exampleSite \
--baseURL "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/"
./build.sh "${{ steps.pages.outputs.base_url }}"

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
uses: actions/upload-pages-artifact@v3
with:
path: ./exampleSite/public
path: ./public

# Deployment job
deploy:
Expand All @@ -71,4 +79,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
62 changes: 62 additions & 0 deletions themes/hextra/.github/workflows/test-accessibility.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Accessibility Tests

on:
pull_request:
branches: [main]

concurrency:
group: accessibility-${{ github.head_ref || github.ref_name }}
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
a11y:
runs-on: ubuntu-latest
environment: accessibility
env:
HUGO_VERSION: 0.156.0
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: recursive

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: "1.26"

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "24"
cache: npm

- name: Setup Hugo
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb

- name: Install dependencies
run: npm ci

- name: Install Playwright Chromium
run: npx playwright install chromium

- name: Build site
run: npm run build

- name: Run accessibility tests
run: npm run test:a11y

- name: Upload report
if: always()
uses: actions/upload-artifact@v4
with:
name: accessibility-report
path: playwright-report/
retention-days: 14
61 changes: 61 additions & 0 deletions themes/hextra/.github/workflows/test-mobile-menu.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Mobile Menu Tests

on:
pull_request:
branches: [main]

concurrency:
group: mobile-menu-${{ github.head_ref || github.ref_name }}
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
mobile-menu:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.156.0
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: recursive

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: "1.26"

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "24"
cache: npm

- name: Setup Hugo
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb

- name: Install dependencies
run: npm ci

- name: Install Playwright Chromium
run: npx playwright install chromium

- name: Build site
run: npm run build

- name: Run mobile menu tests
run: npm run test:mobile-menu

- name: Upload report
if: always()
uses: actions/upload-artifact@v4
with:
name: mobile-menu-report
path: playwright-report/
retention-days: 14
4 changes: 4 additions & 0 deletions themes/hextra/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@ public/
resources/

.hugo_build.lock

# Playwright
playwright-report/
test-results/
3 changes: 3 additions & 0 deletions themes/hextra/.prettierrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"plugins": [
"prettier-plugin-go-template"
],
"goTemplateBracketSpacing": true,
"htmlWhitespaceSensitivity": "css",
"printWidth": 200,
Expand Down
Loading