jSyntax.js 3.1.0

dotnet add package jSyntax.js --version 3.1.0

NuGet\Install-Package jSyntax.js -Version 3.1.0

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="jSyntax.js" Version="3.1.0" />

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

paket add jSyntax.js --version 3.1.0

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

#r "nuget: jSyntax.js, 3.1.0"

#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 jSyntax.js as a Cake Addin
#addin nuget:?package=jSyntax.js&version=3.1.0

// Install jSyntax.js as a Cake Tool
#tool nuget:?package=jSyntax.js&version=3.1.0

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

Syntax.js v3.1.0

A lightweight, and easy-to-use, JavaScript library for code syntax highlighting!

What features does Syntax.js have?

Zero-dependencies and extremely lightweight!
Written in TypeScript, allowing greater support for React, Angular, and other libraries!
Highlights keywords, values, strings, and comments.
51 language translations available!
Full API available via public functions.
Fully styled in CSS/SASS (including the buttons) and compatible with the Bootstrap library.
Full CSS theme support (using :root variables, with a default dark-mode theme).
Coping and Printing support is available via action buttons.
Custom triggers for actions (when elements are rendered, keywords are clicked, etc).
27 of the most popular languages built in by default (with public function support to add more).
Language aliases.
Custom action buttons (via a binding attribute), with opening/closing support.
Unknown language support (renders the display, but does not highlight any syntax).
Tabbing (allows multiple languages to be shown in one tabbed container, which is great for code examples).

Where can I find the documentation?

All the documentation can be found here:

What browsers are supported?

All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.

What languages are supported?

af Afrikaans
ar Arabic
hy Armenian
be Belarusian
bn Bengali
bg Bulgarian
ca Catalan
zh Chinese (simplified)
da Danish
nl Dutch
en English (default)
eo Esperanto
et Estonian
fa Farsi
fi Finnish
fr French
fy Frisian
gl Galician
ka Georgian
de German
el Greek
he Hebrew
hi Hindi
hu Hungarian
is Icelandic
id Indonesian
ga Irish
it Italian
ja Japanese
ko Korean
lv Latvian
lt Lithuanian
lb Luxembourgish
ms Malay
ne Nepali
no Norwegian
pl Polish
pt Portuguese
ro Romanian
si Sinhalese
sk Slovak
sl Slovenian
es Spanish
sv Swedish
tl Tagalog
ta Tamil
zh-tw Taiwanese
te Telugu
th Thai
tr Turkish
uk Ukrainian

What are the most recent changes?

To see a list of all the most recent changes, click here.

What programming languages are supported by default?

bash Bash
c-plus-plus C++
c-sharp C#
c C
css CSS
dart Dart
delphi Delphi
f-sharp F#
go GO
html HTML
java Java
javascript JavaScript
kotlin Kotlin
lua Lua
matlab Matlab
ms-sql Microsoft SQL
perl Perl
php PHP
powershell Powershell
python Python
r R
ruby Ruby
rust Rust
scala Scala
swift Swift
typescript TypeScript
visual-basic Visual Basic

How do I install Syntax.js?

You can install the library with npm into your local modules directory using the following command:

npm install jsyntax.js

Or, you can download the latest zipped up version here.

Or, you can also use the following CDN links:

https://cdn.jsdelivr.net/gh/williamtroup/Syntax.js@3.1.0/dist/syntax.min.js
https://cdn.jsdelivr.net/gh/williamtroup/Syntax.js@3.1.0/dist/syntax.js.min.css

How do I get started?

To get started using Syntax.js, do the following steps:

1. Prerequisites:

Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

<!DOCTYPE html>

2. Include Files:

<link rel="stylesheet" href="dist/syntax.js.css">
<script src="dist/syntax.js"></script>
<script src="dist/languages/syntax.javascript.js"></script>
<script src="dist/languages/syntax.html.js"></script>

3. DOM Element Binding:

<div data-syntax-language="javascript">
    var something = true;

    if ( something ) {
        console.log( "Output is written." ); // Comment
        
        /* Multi-line
        comment */
    }
</div>

<code data-syntax-language="javascript" data-syntax-options="{ 'buttons': { 'showCopy': false } }" data-syntax-buttons="[ { 'text': 'Button 1', 'onClick': yourJsFunction } ]">
    <pre>
        var something = true;

        if ( something ) {
            console.log( "Output is written." ); // Comment
            
            /* Multi-line
            comment */
        }
    </pre>
</code>

<code data-syntax-language="tabbed">
    <div data-syntax-language="javascript" data-syntax-tab-contents="true">
        <pre>
            var something = true;

            if ( something ) {
                console.log( "Output is written." ); // Comment
                
                /* Multi-line
                comment */
            }
        </pre>
    </div>

    <div data-syntax-language="html" data-syntax-tab-contents="{ 'title': 'HTML Language' }">
        <pre>
            <div class="header">
                
                <h1 id="header">Syntax.js - Basic</h1>
                <p>This is a basic example of how to use Syntax.js to highlight code inside a DOM element.</p>
                
            </div>
        </pre>
    </div>
</code>

To see a list of all the available binding languages you can use for "data-syntax-language", click here.

To see a list of all the available binding options you can use for "data-syntax-options", click here.

To see a list of all the available custom triggers you can use for "data-syntax-options", click here.

To see a list of all the available binding options you can use for "data-syntax-buttons", click here.

To see a list of all the available binding options you can use for "data-syntax-tab-contents", click here.

4. Finishing Up:

That's it! Nice and simple. Please refer to the code if you need more help (fully documented).

How do I go about customizing Syntax.js?

To customize, and get more out of Syntax.js, please read through the following documentation.

1. Public Functions:

To see a list of all the public functions available, click here.

2. Configuration:

Configuration options allow you to customize how Syntax.js will function. You can set them as follows:

<script> 
  $syntax.setConfiguration( {
      safeMode: false
  } );
</script>

To see a list of all the available configuration options you can use, click here.

To see a list of all the available configuration options custom triggers you can use, click here.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

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
3.1.0	116	9/6/2024
3.0.1	116	7/18/2024
3.0.0	79	7/15/2024
2.6.0	123	6/18/2024
2.5.0	175	3/29/2024
2.4.3	138	2/26/2024
2.4.2	142	2/6/2024
2.4.1	189	1/18/2024
2.4.0	167	1/15/2024
2.3.1	163	1/4/2024
2.3.0	156	12/30/2023
2.2.0	180	12/29/2023
2.1.1	179	12/26/2023
2.1.0	158	12/20/2023
2.0.1	155	12/19/2023
2.0.0	123	12/18/2023
1.9.0	152	12/15/2023
1.8.2	159	12/13/2023
1.8.1	135	12/13/2023
1.8.0	149	12/11/2023
1.7.3	137	12/10/2023
1.7.2	189	12/10/2023
1.7.1	168	12/10/2023
1.7.0	142	12/9/2023
1.6.2	122	12/8/2023
1.6.1	165	12/8/2023
1.6.0	132	12/7/2023
1.5.1	181	12/6/2023
1.5.0	160	12/6/2023
1.4.0	167	12/5/2023
1.3.0	166	12/5/2023
1.2.0	214	12/4/2023
1.1.0	178	12/2/2023
1.0.0	167	12/1/2023
0.8.0	153	11/30/2023
0.7.0	157	11/28/2023