Skip to content

Commit a1fb363

Browse files
docs: GitHub Pages supports clean URLs (#3468)
1 parent d529ed4 commit a1fb363

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/guide/routing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,17 @@ To serve clean URLs with VitePress, server-side support is required.
129129

130130
By default, VitePress resolves inbound links to URLs ending with `.html`. However, some users may prefer "Clean URLs" without the `.html` extension - for example, `example.com/path` instead of `example.com/path.html`.
131131

132-
Some servers or hosting platforms (for example Netlify or Vercel) provide the ability to map a URL like `/foo` to `/foo.html` if it exists, without a redirect:
132+
Some servers or hosting platforms (for example Netlify, Vercel, GitHub Pages) provide the ability to map a URL like `/foo` to `/foo.html` if it exists, without a redirect:
133133

134-
- Netlify supports this by default.
134+
- Netlify and GitHub Pages support this by default.
135135
- Vercel requires enabling the [`cleanUrls` option in `vercel.json`](https://vercel.com/docs/concepts/projects/project-configuration#cleanurls).
136136

137137
If this feature is available to you, you can then also enable VitePress' own [`cleanUrls`](../reference/site-config#cleanurls) config option so that:
138138

139139
- Inbound links between pages are generated without the `.html` extension.
140140
- If current path ends with `.html`, the router will perform a client-side redirect to the extension-less path.
141141

142-
If, however, you cannot configure your server with such support (e.g. GitHub pages), you will have to manually resort to the following directory structure:
142+
If, however, you cannot configure your server with such support, you will have to manually resort to the following directory structure:
143143

144144
```
145145
.

0 commit comments

Comments
 (0)