Skip to content

Commit

Permalink
Refreshes Retype-generated documentation.
Browse files Browse the repository at this point in the history 
Process triggered by patricklafrance.
  • Loading branch information
Retype GitHub Action committed May 1, 2024
1 parent 3959b03 commit 29f7d49
Show file tree
Hide file tree
Showing 78 changed files with 1,075 additions and 822 deletions.
8 changes: 4 additions & 4 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-root" content="/wl-squide">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.766291168294">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.767839820980">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -29,11 +29,11 @@
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="/wl-squide/static/favicon.png" rel="icon">
<link href="/wl-squide/resources/css/retype.css?v=3.5.0.766291168294" rel="stylesheet">
<link href="/wl-squide/resources/css/retype.css?v=3.5.0.767839820980" rel="stylesheet">

<script data-cfasync="false" src="/wl-squide/resources/js/config.js?v=3.5.0.766291168294" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/wl-squide/resources/js/config.js?v=3.5.0.767839820980" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/wl-squide/resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/wl-squide/resources/js/lunr.js?v=3.5.0.766291168294" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/wl-squide/resources/js/lunr.js?v=3.5.0.767839820980" data-turbo-eval="false" defer></script>

<link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />

Expand Down
8 changes: 4 additions & 4 deletions about/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-root" content="/wl-squide">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.766291168294">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.767839820980">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand Down Expand Up @@ -32,11 +32,11 @@
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../static/favicon.png" rel="icon">
<link href="../resources/css/retype.css?v=3.5.0.766291168294" rel="stylesheet">
<link href="../resources/css/retype.css?v=3.5.0.767839820980" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.766291168294" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.767839820980" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.766291168294" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.767839820980" data-turbo-eval="false" defer></script>

<link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />

Expand Down
118 changes: 85 additions & 33 deletions getting-started/create-host/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-root" content="/wl-squide">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.766291168294">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.767839820980">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand Down Expand Up @@ -32,12 +32,12 @@
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../../static/favicon.png" rel="icon">
<link href="../../resources/css/retype.css?v=3.5.0.766291168294" rel="stylesheet">
<link href="../../resources/css/retype.css?v=3.5.0.767839820980" rel="stylesheet">

<script data-cfasync="false" src="../../resources/js/config.js?v=3.5.0.766291168294" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../../resources/js/config.js?v=3.5.0.767839820980" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.5.0.766291168294" data-turbo-eval="false" defer></script>
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=3.5.0.766291168294" defer></script>
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.5.0.767839820980" data-turbo-eval="false" defer></script>
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=3.5.0.767839820980" defer></script>

<link href="https://gsoft-inc.github.io/wl-idp-docs-hub/static/retype-customization.css" rel="stylesheet" />

Expand Down Expand Up @@ -317,21 +317,21 @@ <h2>
<doc-tab v-cloak id="pnpm">
<template #title>pnpm</template>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-bash"><code v-pre class="language-bash">pnpm add -D @workleap/webpack-configs @workleap/swc-configs @workleap/browserslist-config @squide/firefly-configs webpack webpack-dev-server webpack-cli @swc/core @swc/helpers browserslist postcss typescript
<pre class="language-bash"><code v-pre class="language-bash">pnpm add -D @workleap/webpack-configs @workleap/swc-configs @workleap/browserslist-config @squide/firefly-webpack-configs webpack webpack-dev-server webpack-cli @swc/core @swc/helpers browserslist postcss typescript @types/react @types/react-dom
pnpm add @squide/firefly react react-dom react-router-dom react-error-boundary</code></pre>
</doc-codeblock></div>
</doc-tab>
<doc-tab v-cloak id="yarn">
<template #title>yarn</template>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-bash"><code v-pre class="language-bash">yarn add -D @workleap/webpack-configs @workleap/swc-configs @workleap/browserslist-config @squide/firefly-configs webpack webpack-dev-server webpack-cli @swc/core @swc/helpers browserslist postcss typescript
<pre class="language-bash"><code v-pre class="language-bash">yarn add -D @workleap/webpack-configs @workleap/swc-configs @workleap/browserslist-config @squide/firefly-webpack-configs webpack webpack-dev-server webpack-cli @swc/core @swc/helpers browserslist postcss typescript @types/react @types/react-dom
yarn add @squide/firefly react react-dom react-router-dom react-error-boundary</code></pre>
</doc-codeblock></div>
</doc-tab>
<doc-tab v-cloak id="npm">
<template #title>npm</template>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-bash"><code v-pre class="language-bash">npm install -D @workleap/webpack-configs @workleap/swc-configs @workleap/browserslist-config @squide/firefly-configs webpack webpack-dev-server webpack-cli @swc/core @swc/helpers browserslist postcss typescript
<pre class="language-bash"><code v-pre class="language-bash">npm install -D @workleap/webpack-configs @workleap/swc-configs @workleap/browserslist-config @squide/firefly-webpack-configs webpack webpack-dev-server webpack-cli @swc/core @swc/helpers browserslist postcss typescript @types/react @types/react-dom
npm install @squide/firefly react react-dom react-router-dom react-error-boundary</code></pre>
</doc-codeblock></div>
</doc-tab>
Expand Down Expand Up @@ -367,6 +367,7 @@ <h2>
├──── App.tsx
├──── RootLayout.tsx
├──── HomePage.tsx
├──── NotFoundPage.tsx
├──── bootstrap.tsx
├──── index.ts
├──── register.tsx
Expand Down Expand Up @@ -407,28 +408,22 @@ <h3>
<p>Next, to register the modules, instanciate a shell <a href="../../reference/runtime/runtime-class/">FireflyRuntime</a> instance and register the remote module with the <a href="../../reference/registration/registerremotemodules/">registerRemoteModules</a> function (the configuration of the remote module will be covered in the <a href="../create-remote-module/">next section</a>):</p>
<div class="codeblock-wrapper"><doc-codeblock>
<div class="codeblock-title">host/src/bootstrap.tsx</div>
<pre class="language-tsx" data-line="12-14,17-19,22"><code v-pre class="language-tsx">import { createRoot } from &quot;react-dom/client&quot;;
<pre class="language-tsx" data-line="11-13,16"><code v-pre class="language-tsx">import { createRoot } from &quot;react-dom/client&quot;;
import { ConsoleLogger, RuntimeContext, FireflyRuntime, registerRemoteModules, type RemoteDefinition } from &quot;@squide/firefly&quot;;
import type { AppContext} from &quot;@sample/shared&quot;;
import { App } from &quot;./App.tsx&quot;;

// Define the remote modules.
const Remotes: RemoteDefinition[] = [
{ url: &quot;http://localhost:8081&quot;, name: &quot;remote1&quot; }
{ name: &quot;remote1&quot; }
];

// Create the shell runtime.
const runtime = new FireflyRuntime({
loggers: [new ConsoleLogger()]
});

// Create an optional context.
const context: AppContext = {
name: &quot;Demo application&quot;
};

// Register the remote module.
await registerRemoteModules(Remotes, runtime, { context });
await registerRemoteModules(Remotes, runtime;

const root = createRoot(document.getElementById(&quot;root&quot;)!);

Expand Down Expand Up @@ -596,32 +591,26 @@ <h3>
<p>Finally, update the bootstrapping code to <a href="../../reference/registration/registerlocalmodules/">register</a> the newly created local module:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<div class="codeblock-title">host/src/bootstrap.tsx</div>
<pre class="language-tsx" data-line="23"><code v-pre class="language-tsx">import { createRoot } from &quot;react-dom/client&quot;;
<pre class="language-tsx" data-line="17"><code v-pre class="language-tsx">import { createRoot } from &quot;react-dom/client&quot;;
import { ConsoleLogger, RuntimeContext, FireflyRuntime, registerRemoteModules, type RemoteDefinition } from &quot;@squide/firefly&quot;;
import type { AppContext} from &quot;@sample/shared&quot;;
import { App } from &quot;./App.tsx&quot;;
import { registerHost } from &quot;./register.tsx&quot;;

// Define the remote modules.
const Remotes: RemoteDefinition[] = [
{ url: &quot;http://localhost:8081&quot;, name: &quot;remote1&quot; }
{ name: &quot;remote1&quot; }
];

// Create the shell runtime.
const runtime = new FireflyRuntime({
loggers: [new ConsoleLogger()]
});

// Create an optional context.
const context: AppContext = {
name: &quot;Demo application&quot;
};

// Register the newly created local module.
await registerLocalModules([registerHost], runtime, { context });
await registerLocalModules([registerHost], runtime);

// Register the remote module.
await registerRemoteModules(Remotes, runtime, { context });
await registerRemoteModules(Remotes, runtime);

const root = createRoot(document.getElementById(&quot;root&quot;)!);

Expand All @@ -631,6 +620,55 @@ <h3>
&lt;/RuntimeContext.Provider&gt;
);</code></pre>
</doc-codeblock></div>
<doc-anchor-target id="not-found-page-404">
<h3>
<doc-anchor-trigger class="header-anchor-trigger" to="#not-found-page-404">#</doc-anchor-trigger>
<span>Not found page (404)</span>
</h3>
</doc-anchor-target>
<p>Now, let&#x27;s ensure that users who enter a wrong URL end up somewhere by registering a custom <a href="https://reactrouter.com/en/main/start/faq#how-do-i-add-a-no-match-404-route-in-react-router-v6" class="outbound" target="_blank">no-match route</a>. First, create the <code v-pre>NotFoundPage</code> component, which will serve as the page for handling not found routes:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<div class="codeblock-title">host/src/NotFoundPage.tsx</div>
<pre class="language-tsx"><code v-pre class="language-tsx">export function NotFoundPage() {
return (
&lt;div&gt;Not found! Please try another page.&lt;/div&gt;
);
}</code></pre>
</doc-codeblock></div>
<p>Then, register the newly created component as the <code v-pre>*</code> route:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<div class="codeblock-title">host/src/register.tsx</div>
<pre class="language-tsx" data-line="19-24"><code v-pre class="language-tsx">import { ManagedRoutes, type ModuleRegisterFunction, type FireflyRuntime } from &quot;@squide/firefly&quot;;
import { HomePage } from &quot;./HomePage.tsx&quot;;
import { NotFoundPage } from &quot;./NotFoundPage.tsx&quot;;
import { RootLayout } from &quot;./RootLayout.tsx&quot;;

export const registerHost: ModuleRegisterFunction&lt;FireflyRuntime&gt; = runtime =&gt; {
runtime.registerRoute({
// Pathless route to declare a root layout.
element: &lt;RootLayout /&gt;,
children: [
// Placeholder to indicate where managed routes (routes that are not hoisted or nested)
// will be rendered.
ManagedRoutes
]
}, {
hoist: true
});

runtime.registerRoute({
path: &quot;*&quot;,
element: &lt;NotFoundPage /&gt;
}, {
hoist: true
});

runtime.registerRoute({
index: true,
element: &lt;HomePage /&gt;
});
};</code></pre>
</doc-codeblock></div>
<doc-anchor-target id="configure-webpack">
<h2>
<doc-anchor-trigger class="header-anchor-trigger" to="#configure-webpack">#</doc-anchor-trigger>
Expand Down Expand Up @@ -691,12 +729,19 @@ <h3>
<p>Then, open the <code v-pre>webpack.dev.js</code> file and use the <a href="../../reference/webpack/definedevhostconfig/">defineDevHostConfig</a> function to configure webpack:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<div class="codeblock-title">host/webpack.dev.js</div>
<pre class="language-javascript" data-line="6-13"><code v-pre class="language-javascript">// @ts-check
<pre class="language-javascript" data-line="13-20"><code v-pre class="language-javascript">// @ts-check

import { defineDevHostConfig } from &quot;@squide/firefly-configs&quot;;
import { defineDevHostConfig } from &quot;@squide/firefly-webpack-configs&quot;;
import { swcConfig } from &quot;./swc.dev.js&quot;;

export default defineDevHostConfig(swcConfig, &quot;host&quot;, 8080, {
/**
* @typedef {import(&quot;@squide/firefly-webpack-configs&quot;).RemoteDefinition}[]
*/
const Remotes: RemoteDefinition[] = [
{ name: &quot;remote1&quot;, url: &quot;http://localhost:8081&quot; }
];

export default defineDevHostConfig(swcConfig, &quot;host&quot;, 8080, Remotes, {
sharedDependencies: {
&quot;@sample/shared&quot;: {
singleton: true,
Expand Down Expand Up @@ -728,12 +773,19 @@ <h3>
<p>Then, open the <code v-pre>webpack.build.js</code> file and use the <a href="../../reference/webpack/definebuildhostconfig/">defineBuildHostConfig</a> function to configure webpack:</p>
<div class="codeblock-wrapper"><doc-codeblock>
<div class="codeblock-title">host/webpack.build.js</div>
<pre class="language-javascript" data-line="6-13"><code v-pre class="language-javascript">// @ts-check
<pre class="language-javascript" data-line="13-20"><code v-pre class="language-javascript">// @ts-check

import { defineBuildHostConfig } from &quot;@squide/firefly-configs&quot;;
import { defineBuildHostConfig } from &quot;@squide/firefly-webpack-configs&quot;;
import { swcConfig } from &quot;./swc.build.js&quot;;

export default defineBuildHostConfig(swcConfig, &quot;host&quot;, {
/**
* @typedef {import(&quot;@squide/firefly-webpack-configs&quot;).RemoteDefinition}[]
*/
const Remotes = [
{ name: &quot;remote1&quot;, url: &quot;http://localhost:8081&quot; }
];

export default defineBuildHostConfig(swcConfig, &quot;host&quot;, Remotes, {
sharedDependencies: {
&quot;@sample/shared&quot;: {
singleton: true,
Expand Down
Loading

0 comments on commit 29f7d49

Please sign in to comment.