Do not redirect when appending .html to path #298

nicksellen commented 2024年03月12日 20:03:43 +01:00

VitePress docs describe the feature nicely:

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:

Netlify and GitHub Pages support this by default.
Vercel requires enabling the cleanUrls option in vercel.json.

https://vitepress.dev/guide/routing#generating-clean-url

It almost looks like the redirects feature could do it, but the syntax doesn't support removing the extension.

I found the redirect handling here

Is this something that you'd consider supporting?

Perhaps it'd be something like:

# in _redirects
/*.html /:splat 200

Or a way to support it automagically like netlify and GitHub pages?

VitePress docs describe the feature nicely: > 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: > > Netlify and GitHub Pages support this by default. > Vercel requires enabling the cleanUrls option in vercel.json. https://vitepress.dev/guide/routing#generating-clean-url It _almost_ looks like the [redirects feature](https://docs.codeberg.org/codeberg-pages/redirects/) could do it, but the syntax doesn't support removing the extension. I found the redirect handling here https://codeberg.org/Codeberg/pages-server/src/commit/a6e9510c078758794da5f6a1983b595bfc415de9/server/upstream/redirects.go#L66 Is this something that you'd consider supporting? Perhaps it'd be something like: ``` # in _redirects /*.html /:splat 200 ``` Or a way to support it automagically like netlify and GitHub pages?

Mynacol commented 2024年04月04日 14:48:33 +02:00

Not quite what you asked for, but I noticed on my codeperg pages site that /foo redirects to /foo/ and displays /foo/index.html (at least if a /foo/index.html is available). To the end user that's the same result. You'd need to move the pages in similarly named directories, and old links to /foo.html would break.

Not quite what you asked for, but I noticed on my codeperg pages site that `/foo` redirects to `/foo/` and displays `/foo/index.html` (at least if a `/foo/index.html` is available). To the end user that's the same result. You'd need to move the pages in similarly named directories, and old links to `/foo.html` would break.

nicksellen commented 2024年04月04日 19:50:26 +02:00

Yes, I've used that pattern before!

I don't think vitepress supports that, unless you manually put all your content in files like /foo/index.md - which would not be great, as would result in every page being called index.md.

I think I used to use a jekyll feature/plugin that did it automatically. In some ways it's nicer as it doesn't need any special webserver config. Aesthetically, I do prefer it without the trailing slash. /foo looks nicer than /foo/ to my eyes. Minor detail really though.

Given Netlify, GitHub, and Vercel all support it though, it seems not out of the question to implement it here too :)

Yes, I've used that pattern before! I don't _think_ vitepress supports that, unless you manually put all your content in files like `/foo/index.md` - which would not be great, as would result in every page being called `index.md`. I think I used to use a jekyll feature/plugin that did it automatically. In some ways it's nicer as it doesn't need any special webserver config. Aesthetically, I do prefer it without the trailing slash. `/foo` looks nicer than `/foo/` to my eyes. Minor detail really though. Given Netlify, GitHub, and Vercel all support it though, it seems not out of the question to implement it here too :)

crapStone commented 2024年05月28日 00:10:25 +02:00

This should work already: https://codeberg.org/Codeberg/pages-server/blame/branch/main/server/upstream/upstream.go#L130

This should work already: https://codeberg.org/Codeberg/pages-server/blame/branch/main/server/upstream/upstream.go#L130

nicksellen commented 2024年05月28日 00:30:13 +02:00

Ah nice, I hadn't noticed that, thanks!

Although it issues a 307 redirect rather than serving up the page:

• visit: https://nicksellen.codeberg.page/pages-test/woo
• get redirected to https://nicksellen.codeberg.page/pages-test/woo.html

(repo: https://codeberg.org/nicksellen/pages-test)

whereas the feature I'm talking about is: the ability to map a URL like /foo to /foo.html if it exists, without a redirect

Ah nice, I hadn't noticed that, thanks! Although it issues a 307 redirect rather than serving up the page: - visit: https://nicksellen.codeberg.page/pages-test/woo - get redirected to https://nicksellen.codeberg.page/pages-test/woo.html (repo: https://codeberg.org/nicksellen/pages-test) whereas the feature I'm talking about is: _the ability to map a URL like /foo to /foo.html if it exists, **without a redirect**_

trueqbit commented 2026年04月18日 22:24:35 +02:00

Any chance this feature request will get into the new git-pages version?

It's not a question of Codeberg vs others, rather one of web-server behavior - it is called "Clean URLs" and the standpoint of some SSG authors like Jacky's Quartz 4 is that clean URLs are norm on the web these days.

The Clean URLs thing is not only required for folders where the web server would serve the folder's index.html page if it exists. It's highly relevant for leaf pages like blog posts as well. Manually updating the special _redirects file in each subfolder is tedious and error-prone.

@hw mentioned in #177 that he deployed a solution for git-pages v2.

What needs to be done to make this happen? So someone like me could contribute...

Any chance this feature request will get into the new git-pages version? It's not a question of Codeberg vs others, rather one of web-server behavior - it is called "Clean URLs" and the standpoint of some SSG authors like Jacky's Quartz 4 is that clean URLs are [norm on the web these days](https://github.com/jackyzha0/quartz/issues/591#issuecomment-1812934616). The Clean URLs thing is not only required for folders where the web server would serve the folder's `index.html` page if it exists. It's highly relevant for leaf pages like blog posts as well. Manually updating the special `_redirects` file in each subfolder is tedious and error-prone. @hw mentioned in #177 that he [deployed a solution](https://codeberg.org/Codeberg/Community/issues/177#issuecomment-56020) for git-pages v2. What needs to be done to make this happen? So someone like me could contribute...