feat: Allow extensionless URL HTML file access #10436
Conversation
filzrev
changed the title
filzrev
force-pushed
the
feat-allow-extensionless-htmlurl
branch
from
58072f4 to
8cca247
Compare
| @@ -44,6 +48,7 @@ public static void Exec(string folder, string host, int? port, bool openBrowser, | |||
| Console.WriteLine($"Serving \"{folder}\" on {url}"); | |||
| Console.WriteLine("Press Ctrl+C to shut down"); | |||
| using var app = builder.Build(); | |||
| app.UseExtensionlessHtmlUrl(); | |||
There was a problem hiding this comment.
Should this be opt-in? I think the default behavior should remain a standard static file server so it can be hosted by a variety of web servers.
There was a problem hiding this comment.
This settings is works on docfx serve command only.
And not affect generated HTML files.
So I though it's not a problems by enabled default. (And not support config to disable)
When supporting feature that rewrite URL to extensionless URL automatically.
It should be supported as user's opt-in features.
filzrev
force-pushed
the
feat-allow-extensionless-htmlurl
branch
from
8cca247 to
0f2d784
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #10436 +/- ##
==========================================
+ Coverage 74.31% 79.28% +4.96%
==========================================
Files 536 547 +11
Lines 23189 23649 +460
Branches 4056 4065 +9
==========================================
+ Hits 17234 18749 +1515
+ Misses 4853 3730 -1123
- Partials 1102 1170 +68 ☔ View full report in Codecov by Sentry. |
This PR is intended to add support for extensionless HTML URLs for
docfx servecommand.Background
GitHub Pagessupport extensionless URLs. (e.g. https://dotnet.github.io/docfx/docs/basic-concepts)And other static HTML hosting site also have similar features.
So I thought it's reasonable to support extensionless URLs with the
docfx servecommand.Extensionless URL support is partially related to #2865.
It might be better to add options to output extensionless URLs for docfx internal links.