Brism 1.0.1

.NET 6.0

dotnet add package Brism --version 1.0.1

NuGet\Install-Package Brism -Version 1.0.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Brism" Version="1.0.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Brism --version 1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Brism, 1.0.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Brism as a Cake Addin
#addin nuget:?package=Brism&version=1.0.1

// Install Brism as a Cake Tool
#tool nuget:?package=Brism&version=1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Brism - Syntax Highlighting Made Easy for Blazor

Screenshot of component in action 1

Brism brings the power of PrismJS to Blazor, making your code examples look fantastic with minimal effort. Perfect for documentation, blogs, or any application that needs beautiful code snippets.

Features

Syntax highlighting that actually looks good
Line numbers (that you can toggle on/off)
Cool command-line styling for terminal examples
Works seamlessly with Blazor Server and WebAssembly
Pick from various themes to match your site
Super easy to set up (seriously, it takes like 2 minutes)
Type-safe language selection (no more typos!)

Getting Started

1. Install the NuGet Package

dotnet add package Brism

2. Add Required Files

In your App.razor file (or _Host.cshtml for Server-side Blazor), add these lines in the <head> section:


<link href="_content/Brism/prism.css" rel="stylesheet" />


<link href="_content/Brism/prism-synthwave84.css" rel="stylesheet" />

And these scripts at the end of the <body>:

<script src="_content/Brism/prism.js"></script>

<script type="module" src="_content/Brism/prismInterop.js"></script>

3. Wire It Up

Add this to your Program.cs:

builder.Services.AddBrism();

4. Import It

Add this to your _Imports.razor:

@using Brism

5. Use It!

Drop this into any of your Blazor pages:

<CodeBlock
    Code="@myCode"
    Language="CodeLanguage.CSharp"
    EnableLineNumbers="true" />

Available Themes

Dark Themes

Modern & Sleek
- prism-one-dark.css - Atom's One Dark
- prism-material-dark.css - Material Design inspired
- prism-vsc-dark-plus.css - VS Code dark theme
- prism-dracula.css - Famous Dracula theme
- prism-synthwave84.css - Retro synthwave vibes
Rich & Deep
- prism-night-owl.css - Perfect for night coding
- prism-nord.css - Cool Nordic theme
- prism-material-oceanic.css - Deep blue oceanic
- prism-darcula.css - IntelliJ-inspired
- prism-shades-of-purple.css - Vibrant purple theme
Nature-Inspired
- prism-duotone-dark.css - Subtle two-tone dark
- prism-duotone-forest.css - Forest-inspired colors
- prism-duotone-earth.css - Earthy tones
- prism-duotone-sea.css - Ocean-inspired theme
- prism-duotone-space.css - Space-like dark theme

Light Themes

Clean & Professional
- prism-one-light.css - Atom's One Light theme
- prism-material-light.css - Material Design light
- prism-vs.css - Visual Studio inspired
Soft & Gentle
- prism-duotone-light.css - Gentle two-tone light
- prism-gruvbox-light.css - Soft retro colors
- prism-coldark-cold.css - Cool light tones

Special Themes

Unique Styles
- prism-lucario.css - Pokémon-inspired
- prism-hopscotch.css - Playful and colorful
- prism-holi-theme.css - Festive and bright
- prism-laserwave.css - Retro laser theme
- prism-z-touch.css - Modern touch

High Contrast

prism-a11y-dark.css - Accessibility-focused dark theme
prism-cb.css - Color-blind friendly
prism-ghcolors.css - GitHub-like colors

Making It Your Own

Here's what you can tweak:

Property	What it does	Default
Code	Your code snippet (required)	-
Language	The language for highlighting (required)	-
EnableLineNumbers	Show/hide line numbers	true
EnableCommandLine	Add a command prompt look	false
CommandLineUser	Custom prompt user	"User"
CommandLineHost	Custom prompt host	"Host"
Css	Extra CSS if you need it	""

Languages? We've Got Them All!

No more guessing language names or dealing with typos! We provide a handy CodeLanguage enum with constants for all supported languages. Here are some popular ones:

// Common languages
CodeLanguage.CSharp      // for C#
CodeLanguage.JavaScript  // for JavaScript
CodeLanguage.TypeScript  // for TypeScript
CodeLanguage.Python      // for Python
CodeLanguage.Html        // for HTML
CodeLanguage.Css         // for CSS
CodeLanguage.Json        // for JSON
CodeLanguage.Sql         // for SQL
CodeLanguage.Docker      // for Dockerfiles
CodeLanguage.Yaml        // for YAML/YML
CodeLanguage.Markdown    // for Markdown
CodeLanguage.Bash        // for Shell scripts

And that's just the tip of the iceberg! We support 180+ languages, including:

All major web technologies
Popular programming languages
Markup and styling languages
Configuration formats
Domain-specific languages
And tons more!

Just use the CodeLanguage enum to ensure you're always using the correct language identifier.

Cool Things You Can Do

Command Line Style

Perfect for showing terminal commands:

<CodeBlock
    Code="npm install something-cool"
    Language="CodeLanguage.Bash"
    EnableCommandLine="true"
    CommandLineUser="dev"
    CommandLineHost="laptop" />

Clean Code View

When you just want the code without the extras:

<CodeBlock
    Code="@myCleanCode"
    Language="CodeLanguage.CSharp"
    EnableLineNumbers="false" />

Multiple Languages in One Page

Mix and match different languages:

<CodeBlock Code="@cssCode" Language="CodeLanguage.Css" />
<CodeBlock Code="@htmlCode" Language="CodeLanguage.Html" />
<CodeBlock Code="@jsCode" Language="CodeLanguage.JavaScript" />

Want to Help?

We'd love to have you on board! Here's how you can contribute:

Fork it
Create your feature branch (git checkout -b feature/cool-new-thing)
Make your changes
Push to the branch (git push origin feature/cool-new-thing)
Open a Pull Request

Even small improvements are welcome - found a typo? Fixed a bug? We appreciate all contributions!

The Legal Stuff

This project is under the MIT License - basically, you can do whatever you want with it, just keep the license notice. See the LICENSE file for the formal details.

Show Some Love

If Brism makes your life easier:

Give us a star on GitHub
Tell your fellow devs about it
Found a bug? Open an issue
Have an idea? Let's hear it!

Thank You!

Big thanks to:

The amazing PrismJS team
Everyone who has contributed
You, for checking out our project!

Built with passion for the Blazor community

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Microsoft.AspNetCore.Components (>= 6.0.36)
- Microsoft.AspNetCore.Components.Web (>= 6.0.36)
net7.0
- Microsoft.AspNetCore.Components (>= 7.0.20)
- Microsoft.AspNetCore.Components.Web (>= 7.0.20)
net8.0
- Microsoft.AspNetCore.Components (>= 8.0.11)
- Microsoft.AspNetCore.Components.Web (>= 8.0.11)
net9.0
- Microsoft.AspNetCore.Components (>= 9.0.0)
- Microsoft.AspNetCore.Components.Web (>= 9.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.0.1	751	1/9/2025
1.0.0	11,169	10/30/2024