24 lines
2.9 KiB
Plaintext
24 lines
2.9 KiB
Plaintext
page InstallationGuide {
|
|
layout = "showcase"
|
|
seo {
|
|
title = "Installation"
|
|
description = "Install the package and import the shared stylesheet once in your application."
|
|
}
|
|
view {
|
|
<article class="page-docs guide-page">
|
|
<nav class="docs-breadcrumbs" aria-label="Breadcrumb"><a href="/docs">Docs</a><span aria-hidden="true">/</span><span>Installation</span></nav>
|
|
<header class="docs-intro"><span class="showcase-eyebrow">Getting Started</span><h1>Installation</h1><p>Install the package and import the shared stylesheet once in your application.</p></header>
|
|
<section class="guide-section guide-example"><h2>Configure and use it</h2><p>This is the smallest useful starting point. Copy it into the indicated application file or run it from the project root, then adjust the documented values for your product.</p><pre><code>bun add @wrnexus/ui@0.8.7
|
|
bunx wrnexus typecheck .
|
|
bunx wrnexus inspect packages .
|
|
bunx wrnexus build .</code></pre><h3>What changes after this</h3><p>The UI package becomes discoverable by development, type-check, and production builds without manually copying component CSS.</p></section>
|
|
<section class="guide-section"><h2>Prerequisites</h2><p>Use Bun 1.3 or newer and a WRNexus application whose framework packages share the same version. Private-preview installs require npm credentials with access to the @wrnexus scope.</p></section><section class="guide-section"><h2>Install the UI package</h2><p>Add @wrnexus/ui to the application. The dev server and production builder discover its component directory, styles, tokens, and metadata automatically.</p></section><section class="guide-section"><h2>Verify discovery</h2><p>Run the type checker and inspect packages. A healthy application reports valid application types and lists @wrnexus/ui among its resolved packages.</p></section><section class="guide-section"><h2>Production check</h2><p>Build once before deployment. Confirm the report lists UI components, the selected active theme, and the application stylesheet without loading the complete theme matrix.</p></section>
|
|
<section class="guide-section"><h2>Verify the result</h2><p>Type-check the application, inspect the resolved package and styles, and build the production artifact. Test the page at a narrow viewport, with keyboard navigation, and in both color modes before shipping.</p><pre><code>bunx wrnexus typecheck .
|
|
bunx wrnexus inspect packages .
|
|
bunx wrnexus inspect styles .
|
|
bunx wrnexus build .</code></pre><h3>Expected result</h3><p>The commands exit successfully, the build reports the installed UI components and active theme, and the rendered page remains usable before and after hydration.</p></section>
|
|
<nav class="guide-next"><a href="/components/button">Explore components <span aria-hidden="true">→</span></a><a href="/block-library">Browse blocks <span aria-hidden="true">→</span></a></nav>
|
|
</article>
|
|
}
|
|
}
|