Skip to content

feat: Add generated Open Graph images for docs pages #769

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

Merged
developerjamiu merged 3 commits into from
Sep 3, 2026
Merged

feat: Add generated Open Graph images for docs pages #769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8d719b
feat: Add generated Open Graph images for docs pages
developerjamiu Aug 31, 2026
b110424
chore: Remove template comments from docusaurus.config.js
developerjamiu Aug 31, 2026
0c7d96b
feat: Redesign Open Graph cards and verify them in CI
developerjamiu Sep 2, 2026
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
5 changes: 5 additions & 0 deletions .github/workflows/deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,16 @@ jobs:
run: |
cd src
npm ci
npm run test:open-graph
npm run build
- name: Verify markdown export
run: |
cd src
node util/verify_markdown_export.js
- name: Verify Open Graph images
run: |
cd src
node util/verify_open_graph_images.js
- uses: actions/checkout@v4
with:
path: target
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/test-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ jobs:
cache: npm
- name: Install dependencies
run: npm ci
- name: Test Open Graph images
run: npm run test:open-graph
- name: Build
run: npm run build
- name: Verify markdown export
run: node util/verify_markdown_export.js
run: node util/verify_markdown_export.js
- name: Verify Open Graph images
run: node util/verify_open_graph_images.js
12 changes: 5 additions & 7 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

import {
themes
Expand All @@ -17,8 +16,8 @@ const config = {
onBrokenLinks: 'throw',
onBrokenAnchors: 'throw',
favicon: 'img/favicon.png',
organizationName: 'serverpod', // Usually your GitHub org/user name.
Comment thread
developerjamiu marked this conversation as resolved.
projectName: 'serverpod.github.io', // Usually your repo name.
organizationName: 'serverpod',
projectName: 'serverpod.github.io',
trailingSlash: false,

markdown: {
Expand All @@ -37,7 +36,6 @@ const config = {
docs: {
routeBasePath: '/',
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl: 'https://github.com/serverpod/serverpod_docs/tree/main/',
breadcrumbs: false,
},
Expand All @@ -64,7 +62,6 @@ const config = {
disableSwitch: true,
},
navbar: {
// title: 'My Site',
logo: {
alt: 'Serverpod Logo',
src: 'img/logo-horizontal.svg',
Expand Down Expand Up @@ -112,7 +109,7 @@ const config = {
],
},
algolia: {
// Algolia DocSearch configuration. `apiKey` is safe to commit.
// The search-only `apiKey` is safe to commit.
appId: '6LZRX3JBXY',
indexName: 'Serverpod docs',
apiKey: '2f0125e1ff6fe9469eac332ea47423d6',
Expand All @@ -137,6 +134,7 @@ const config = {
async: true,
}, ],
plugins: [
'./plugins/open-graph-images',
[
'@docusaurus/plugin-content-docs',
{
Expand Down Expand Up @@ -190,4 +188,4 @@ const config = {
],
};

module.exports = config;
module.exports = config;
Loading
Loading