Skip to content

Add installation steps for Tailwind CSS v4.0 & Linux environments #157

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.

Sign up for GitHub

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add installation steps for Tailwind CSS v4.0 & Linux environments #157

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3af47b
Add installation steps for Tailwind CSS v4.0 & Linux environments
Jan 25, 2025
7de62d9
Correct typos and improve page formatting
Jan 25, 2025
0f243c4
Fix indentation in Targets files
Jan 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/LumexUI.Docs.Client/Components/Layouts/InstallationLayout.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@
</li>
</ul>
</DocsSection>

<Callout Variant="@CalloutVariant.Warning">
Depending on the version of Tailwind CSS you plan on using, the instructions may differ slightly.
Make sure you pick the correct version before proceeding.
</Callout>
<ul>
<li><LumexLink Href="/docs/getting-started/installation#instructions-for-tailwind-css-v3.*" External="false">Install LumixUI with Tailwind CSS v3.*</LumexLink></li>
<li><LumexLink Href="/docs/getting-started/installation#instructions-for-tailwind-css-v4.0" External="false">Install LumixUI with Tailwind CSS v4.0</LumexLink></li>
</ul>
<LumexDivider />
</div>

Expand Down
102 changes: 92 additions & 10 deletions docs/LumexUI.Docs.Client/Pages/Getting Started/Installation.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
@page "/docs/getting-started/installation"
@layout InstallationLayout

<InstallationSteps Steps="@_steps" />
<DocsSection Title="Instructions for Tailwind CSS v3.*">
<InstallationSteps Steps="@_stepsForTailwindCssv3" />
</DocsSection>

<LumexDivider />

<DocsSection Title="Instructions for Tailwind CSS v4.0">
<InstallationSteps Steps="@_stepsForTailwindCssv4" />
</DocsSection>

@code {
private Step[] _steps = new Step[]
private readonly Step[] _stepsForTailwindCssv3 = new Step[]
{
new Step()
{
Expand All @@ -14,16 +22,90 @@
},
new Step()
{
Title = "Install Tailwind CSS",
Title = "Install Tailwind CSS (up to v3.*)",
Code = new CodeBlock("tailwind.config.js", "installationConfig"),
Body = @<text>
<p>
LumexUI is built on top of Tailwind CSS. To install, follow the official <LumexLink Href="https://tailwindcss.com/docs/installation" External="@true">installation guide</LumexLink>. Then, modify the <code>tailwind.config.js</code> file.
</p>
<i>
Note: the <code>PATH_TO_NUGET</code> is the NuGet package path on the machine.
</i>
</text>
<p>
LumexUI is built on top of Tailwind CSS. To install, follow the official <LumexLink Href="https://v3.tailwindcss.com/docs/installation" External="@true">installation guide</LumexLink>. Then, modify the <code>tailwind.config.js</code> file.
</p>
<i>
Note: the <code>PATH_TO_NUGET</code> is the NuGet package path on the machine.
</i>
<i>
Note: if you are using Tailwind CSS v4.0, see /docs/getting-started/installation/tailwindcssv4 instead.
</i>
</text>
},
new Step()
{
Title = "Configure startup file",
Code = new CodeBlock("Program.cs", "installationServices"),
Body = @<p>Inject the vital LumexUI services in the <code>Program.cs</code>.</p>
},
new Step()
{
Title = "Include CSS and JS",
Code = new CodeBlock("App.razor", "installationFiles"),
Body = @<p>Include the mandatory static files into the <code>@("<head>")</code> and the <code>@("<body>")</code>.</p>
},
new Step()
{
Title = "Import library's namespace",
Code = new CodeBlock("_Imports.razor", "installationImport"),
Body = @<p>Modify <code>_Imports.razor</code> file to easily access components throughout your app.</p>
},
new Step()
{
Title = "Setup theme provider",
Code = new CodeBlock("MainLayout.razor", "installationThemeProvider"),
Body = @<p>Add the <code>LumexThemeProvider</code> into your <code>MainLayout.razor</code> file to enable theming.</p>
},
new Step()
{
Title = "Use the components",
Code = new CodeBlock("Index.razor", "installationUsage"),
Body = @<p>Now you are all set up to start using LumexUI components in your app!</p>
}
};

private readonly Step[] _stepsForTailwindCssv4 = new Step[]
{
new Step()
{
Title = "Install LumexUI",
Code = new CodeBlock("Terminal", "installationPackage"),
Body = @<p>Install LumexUI via terminal using .NET CLI.</p>
},
new Step()
{
Title = "Install Tailwind CSS (Windows)",
Code = new CodeBlock("App.csproj", "installationTargetsWindows"),
Body = @<p>
Modify the main <code>.csproj</code> file that serves your app.
This will download the Tailwind CSS standalone CLI if not found and run it when the app builds.
</p>
},
new Step()
{
Title = "Install Tailwind CSS (Linux)",
Code = new CodeBlock("App.csproj", "installationTargetsLinux"),
Body = @<p>
Modify the main <code>.csproj</code> file that serves your app.
This will automatically download the Tailwind CSS standalone CLI if not found, give it execute permissions, and run it when the app builds.
</p>
},
new Step()
{
Title = "Import Tailwind CSS in your CSS file",
Code = new CodeBlock("app.css", "installationConfigTailwindV4"),
Body = @<text>
<p>
Import and configure Tailwind CSS in the main <code>.css</code> file of your app.
</p>
<i>
Note: the <code>PATH_TO_NUGET</code> is the path to the folder that contains NuGet packages on your machine.
</i>
</text>
},
new Step()
{
Expand Down
6 changes: 6 additions & 0 deletions docs/LumexUI.Docs.Client/Samples/Installation/installationConfigTailwindV4.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<pre><code class="language-css">@import 'tailwindcss';

@plugin '{PATH_TO_NUGET}/theme/plugin.js';

@source '{PATH_TO_NUGET}/theme/components/*.cs';
</code></pre>
9 changes: 9 additions & 0 deletions docs/LumexUI.Docs.Client/Samples/Installation/installationTargetsLinux.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<pre lang="xml"><code class="language-xml">&lt;Target Name="InstallTailwind" AfterTargets="PostBuildEvent" Condition="!Exists('tailwindcss')"&gt;
&lt;Exec Command="wget -O tailwindcss https://github.com/tailwindlabs/tailwindcss/releases/latest/download/tailwindcss-linux-x64" /&gt;
&lt;Exec Command="chmod u+x tailwindcss" /&gt;
&lt;/Target&gt;

&lt;Target Name="RunTailwind" AfterTargets="InstallTailwind"&gt;
&lt;Exec Command="./tailwindcss -i ./wwwroot/app.css -o ./wwwroot/output.css --minify" /&gt;
&lt;/Target&gt;
</code></pre>
9 changes: 9 additions & 0 deletions docs/LumexUI.Docs.Client/Samples/Installation/installationTargetsWindows.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<pre><code class="language-xml"> &lt;Target Name="InstallTailwind" AfterTargets="PostBuildEvent" Condition="!Exists('tailwindcss.exe')"&gt;
&lt;Exec Command="curl -LO https://github.com/tailwindlabs/tailwindcss/releases/latest/download/tailwindcss-windows-x64.exe" /&gt;
&lt;Exec Command="ren tailwindcss-windows-x64.exe tailwindcss.exe" /&gt;
&lt;/Target&gt;

&lt;Target Name="RunTailwind" AfterTargets="InstallTailwind"&gt;
&lt;Exec Command="tailwindcss -i ./wwwroot/app.css -o ./wwwroot/output.css --minify" /&gt;
&lt;/Target&gt;
</code></pre>