3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-04 03:42:34 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(core): hash router option - browse site offline (experimental) (#9859)

Browse source
This commit is contained in:
Sébastien Lorber 2024-05-19 15:44:58 +02:00 • committed by GitHub
parent b73ad1ece5
commit 17f3e02a42
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
38 changed files with 1018 additions and 266 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/api/docusaurus.config.js.mdx
View file

@ -201,6 +201,7 @@ export default {
type: 'localStorage',
namespace: true,
},
experimental_router: 'hash',
},
};
```
@ -208,6 +209,7 @@ export default {
- `experimental_storage`: Site-wide browser storage options that theme authors should strive to respect.
- `type`: The browser storage theme authors should use. Possible values are `localStorage` and `sessionStorage`. Defaults to `localStorage`.
- `namespace`: Whether to namespace the browser storage keys to avoid storage key conflicts when Docusaurus sites are hosted under the same domain, or on localhost. Possible values are `string | boolean`. The namespace is appended at the end of the storage keys `key-namespace`. Use `true` to automatically generate a random namespace from your site `url + baseUrl`. Defaults to `false` (no namespace, historical behavior).
- `experimental_router`: The router type to use. Possible values are `browser` and `hash`. Defaults to `browser`. The `hash` router is only useful for rare cases where you want to opt-out of static site generation, have a fully client-side app with a single `index.html` entrypoint file. This can be useful to distribute a Docusaurus site as a `.zip` archive that you can [browse locally without running a web server](https://github.com/facebook/docusaurus/issues/3825).
### `noIndex` {#noIndex}