Skip to content

Commit 74120ab

Browse files
committed
docs: update internal links to use .html extensions for consistency
- Updated internal links in `HomeLanding.vue` and site configuration to include `.html` extensions. - Adjusted sidebar, navigation, and metadata paths for uniformity. - Removed unused `disposable-email-json-preview.png` file.
1 parent 0aed5cc commit 74120ab

3 files changed

Lines changed: 24 additions & 22 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const canonicalUrl = (page: string): string => {
88
.replace(/(^|\/)index\.md$/, '$1')
99
.replace(/\.md$/, '')
1010

11-
return `${siteUrl}${path ? `/${path}` : '/'}`
11+
return `${siteUrl}${path ? `/${path}.html` : '/index.html'}`
1212
}
1313

1414
const searchConsoleVerification = 'OZHlBl5qnZRHEArDBmPQeDqrhUr0K32DjQDZ8YxrtuM'
@@ -23,9 +23,10 @@ export default defineConfig({
2323
hostname: siteUrl,
2424
transformItems: (items) => items.map((item) => {
2525
const path = item.url.startsWith('/') ? item.url : `/${item.url}`
26-
const url = path === '/' || !path.startsWith(siteBase)
27-
? `${siteBase}${path}`
28-
: path
26+
const normalizedPath = path === '/' ? '/index.html' : path
27+
const url = !normalizedPath.startsWith(siteBase)
28+
? `${siteBase}${normalizedPath}`
29+
: normalizedPath
2930

3031
return {
3132
...item,
@@ -102,29 +103,30 @@ export default defineConfig({
102103
]
103104
},
104105
themeConfig: {
106+
logoLink: `${siteBase}/index.html`,
105107
nav: [
106-
{ text: 'Get started', link: '/introduction' },
108+
{ text: 'Get started', link: '/introduction.html' },
107109
],
108110
sidebar: [
109111
{
110112
text: 'Docs',
111113
items: [
112-
{ text: 'Overview', link: '/' },
113-
{ text: 'Introduction', link: '/introduction' },
114-
{ text: 'Installation', link: '/getting-started' },
115-
{ text: 'Config', link: '/configuration' }
114+
{ text: 'Overview', link: '/index.html' },
115+
{ text: 'Introduction', link: '/introduction.html' },
116+
{ text: 'Installation', link: '/getting-started.html' },
117+
{ text: 'Config', link: '/configuration.html' }
116118
]
117119
},
118120
{
119121
text: 'Usage',
120122
items: [
121-
{ text: 'Validation and Runtime', link: '/validation-and-runtime' },
122-
{ text: 'Sync and Blacklist', link: '/sync-and-blacklist' },
123-
{ text: 'Schedule Sync', link: '/schedule-syncing-automatically' },
124-
{ text: 'Caching', link: '/caching' },
125-
{ text: 'Troubleshooting', link: '/troubleshooting' },
126-
{ text: 'Contributing', link: '/contributing' },
127-
{ text: 'Deprecated 5.0.0', link: '/deprecated-5-0-0' }
123+
{ text: 'Validation and Runtime', link: '/validation-and-runtime.html' },
124+
{ text: 'Sync and Blacklist', link: '/sync-and-blacklist.html' },
125+
{ text: 'Schedule Sync', link: '/schedule-syncing-automatically.html' },
126+
{ text: 'Caching', link: '/caching.html' },
127+
{ text: 'Troubleshooting', link: '/troubleshooting.html' },
128+
{ text: 'Contributing', link: '/contributing.html' },
129+
{ text: 'Deprecated 5.0.0', link: '/deprecated-5-0-0.html' }
128130
]
129131
}
130132
],

docs/.vitepress/theme/components/HomeLanding.vue

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ import { withBase } from 'vitepress'
1414
support, custom blacklist support, and optional caching for faster lookups.
1515
</p>
1616
<div class="quick-links">
17-
<a :href="withBase('/getting-started')">Get started</a>
18-
<a :href="withBase('/validation-and-runtime')">See validation examples</a>
17+
<a :href="withBase('/getting-started.html')">Get started</a>
18+
<a :href="withBase('/validation-and-runtime.html')">See validation examples</a>
1919
<a href="https://github.com/eramitgupta/laravel-disposable-email">GitHub</a>
2020
</div>
2121
</div>
@@ -184,10 +184,10 @@ import { withBase } from 'vitepress'
184184
syncing, and caching to set up a complete disposable email blocking workflow.
185185
</p>
186186
<div class="quick-links">
187-
<a :href="withBase('/getting-started')">Installation guide</a>
188-
<a :href="withBase('/configuration')">Configuration options</a>
189-
<a :href="withBase('/sync-and-blacklist')">Sync and blacklist</a>
190-
<a :href="withBase('/caching')">Caching notes</a>
187+
<a :href="withBase('/getting-started.html')">Installation guide</a>
188+
<a :href="withBase('/configuration.html')">Configuration options</a>
189+
<a :href="withBase('/sync-and-blacklist.html')">Sync and blacklist</a>
190+
<a :href="withBase('/caching.html')">Caching notes</a>
191191
</div>
192192
</div>
193193
</div>
-161 KB
Binary file not shown.

0 commit comments

Comments
 (0)