-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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.
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
feat(core): hash router option - browse site offline (experimental) #9859
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Size Change: +845 B (+0.05%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
This was referenced Feb 17, 2024
Do not compile a server bundle that we won't use
Looking forward that this will be release in the future! |
This was referenced Sep 2, 2024
This was referenced Sep 2, 2024
This was referenced Sep 4, 2024
This was referenced Sep 4, 2024
This was referenced Sep 4, 2024
This was referenced Sep 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Argos
Add this label to run UI visual regression tests. See argos.yml GH action.
CLA Signed
Signed Facebook CLA
pr: new feature
This PR adds a new API or behavior.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
New site config option:
See also my comment here that presents the feature: #3825 (comment)
The hash router is useful in rare cases, and will:
/#/
prefixindex.html
fileIn practice, all the URLs will load a single
index.html
empty shell file, and will look like:https://docusaurus.io/#/
https://docusaurus.io/#/docs
https://docusaurus.io/#/docs/myDoc?age=42#someHeading
The motivation for this new router feature is to fix #3825, and allow distributing a Docusaurus site as a standalone
.zip
archive that can be browsed without a web server, using thefile://
protocol (exfile://path/to/site/index.html
)Note using the hash router will disable the following features that probably do not make much sense under this new mode:
EXPERIMENTAL FEATURE:
The hash router is likely to contain unhandled edge cases. Notably if you plan to use the
file://
protocol, or have a site/baseUrl/
.hash router + baseUrl = bugs 🐛
If you plan to use the hash router, we'd recommend using it without a
/baseUrl/
param. It probably does not make sense to use it anyway, because we try to make all links relative to make it work with thefile://
protocol, so hosting it on any subpath should work fine.There's also a bit of ambiguity because baseUrl
/docusaurus/
would mean that you access the app through a link such ashttps://myUrl.com/#/baseUrl/
, and nothttps://myUrl.com/baseUrl/#/
like most of you would probably expect. There's probably no good reason to host the app under a hash subpath.Unless someone comes up with a strong motivation for hash router + baseUrl, we are likely to forbid/ignore the usage of a baseUrl with hash router in the future. So please share your use case in the comments!
Test Plan
Unit tests + new CI workflow
That's so easy to dogfood, unfortunately. This has quite a large API surface. We probably need new Playwright tests to ensure this keeps working reliably over time, in particular the offline mode using
file://
protocol.To make it easier to manually review the hash router, we:
file://
Test links
Docs: https://deploy-preview-9859--docusaurus-2.netlify.app/docs/api/docusaurus-config/#future