From 51c4ebe644e90ba248666162c09020de5f6093f4 Mon Sep 17 00:00:00 2001 From: Owen Buckley Date: Fri, 9 Dec 2022 20:19:43 -0500 Subject: [PATCH] link router discussion in static router experimental disclaimer --- www/pages/docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/pages/docs/configuration.md b/www/pages/docs/configuration.md index 670f38742..a72c0e9cd 100644 --- a/www/pages/docs/configuration.md +++ b/www/pages/docs/configuration.md @@ -188,7 +188,7 @@ export default { ### Static Router -> _This feature is considered experimental._ +> ⚠️ _This feature is experimental. Please follow along with [our discussion](https://github.com/ProjectEvergreen/greenwood/discussions/1033) to learn more._ Setting the `staticRouter` option to `true` will add a small router runtime in production for static pages to prevent needing full page reloads when navigation between pages that share a template. For example, the Greenwood website is entirely static, outputting an HTML file per page however, if you navigate from the _Docs_ page to the _Getting Started_ page, you will notice the site does not require a full page load. Instead, the router will just swap out the content of the page much like client-side SPA router would. This technique is similar to how projects like [**pjax**](https://github.com/defunkt/jquery-pjax) and [**Turbolinks**](https://github.com/turbolinks/turbolinks) work, and like what you can see on websites like GitHub.