Skip to content

fix(docs): handle base path for subpath deployment on GitHub Pages #55

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
MorganCaron merged 1 commit into from
Oct 2, 2026
Merged

fix(docs): handle base path for subpath deployment on GitHub Pages #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions docs/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import starlight from '@astrojs/starlight';
import mdx from '@astrojs/mdx';
import sitemap from '@astrojs/sitemap';
import { pluginLineNumbers } from '@expressive-code/plugin-line-numbers';
import { starlightBasePath } from 'starlight-base-path';
import starlightLinksValidator from 'starlight-links-validator';
import starlightScrollToTop from 'starlight-scroll-to-top';
import starlightAnnouncement from 'starlight-announcement';
Expand All @@ -21,6 +22,7 @@ export default defineConfig({
integrations: [
starlight({
plugins: [
starlightBasePath(),
starlightLinksValidator({
errorOnFallbackPages: false,
}),
Expand Down
20 changes: 20 additions & 0 deletions docs/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@
"mermaid": "^11.17.2",
"sharp": "^0.35.3",
"starlight-announcement": "^2.0.0",
"starlight-base-path": "^0.2.1",
"starlight-fullview-mode": "^0.2.6",
"starlight-links-validator": "^0.26.0",
"starlight-plugin-icons": "^1.1.6",
"starlight-scroll-to-top": "^2.0.0",
"unocss": "^66.10.5",
"unist-util-visit": "^5.1.0"
"unist-util-visit": "^5.1.0",
"unocss": "^66.10.5"
}
}
8 changes: 5 additions & 3 deletions docs/src/content/docs/en/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,22 @@ hero:
import { Card, CardGrid } from '@astrojs/starlight/components';
import { ContributorList } from 'astro-contributors';

export const base = import.meta.env.BASE_URL.replace(/\/$/, '');

## Discover the documentation

<CardGrid stagger>
<a href="/en/guides/getting-started/" class="card-link">
<a href={`${base}/en/guides/getting-started/`} class="card-link">
<Card title="Getting started" icon="rocket">
Step-by-step installation with XMake and Clang, and building your first modular C++26 program.
</Card>
</a>
<a href="/en/guides/lockers/" class="card-link">
<a href={`${base}/en/guides/lockers/`} class="card-link">
<Card title="RAII synchronization" icon="pencil">
Practical guide to using `UniqueLocker` and `SharedLocker` to safely protect shared resources.
</Card>
</a>
<a href="/en/reference/" class="card-link">
<a href={`${base}/en/reference/`} class="card-link">
<Card title="C++ API reference" icon="open-book">
Full function signatures, method descriptions, move semantics, and RAII accessor classes.
</Card>
Expand Down
8 changes: 5 additions & 3 deletions docs/src/content/docs/fr/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,22 @@ hero:
import { Card, CardGrid } from '@astrojs/starlight/components';
import { ContributorList } from 'astro-contributors';

export const base = import.meta.env.BASE_URL.replace(/\/$/, '');

## Découvrir la documentation

<CardGrid stagger>
<a href="/fr/guides/getting-started/" class="card-link">
<a href={`${base}/fr/guides/getting-started/`} class="card-link">
<Card title="Prise en main" icon="rocket">
Installation pas-à-pas avec XMake et Clang, et compilation de votre premier programme modulaire C++26.
</Card>
</a>
<a href="/fr/guides/lockers/" class="card-link">
<a href={`${base}/fr/guides/lockers/`} class="card-link">
<Card title="Synchronisation RAII" icon="pencil">
Guide pratique pour utiliser `UniqueLocker` et `SharedLocker` afin de sécuriser l'accès aux données partagées.
</Card>
</a>
<a href="/fr/reference/" class="card-link">
<a href={`${base}/fr/reference/`} class="card-link">
<Card title="Référence d'API C++" icon="open-book">
Signatures complètes, descriptions de méthodes, sémantique de déplacement et classes d'accès.
</Card>
Expand Down
Loading