Syntax.js

A lightweight, and easy-to-use, JavaScript library for code syntax highligh...

Syntax highlighting
williamtroup/Syntax.jsjsyntax.js

README

Syntax.js


What features does Syntax.js have?


- Zero-dependencies and extremely lightweight!
- 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).
- Custom triggers for actions (when elements are rendered, keywords are clicked, etc).
- 12 of the most popular languages built in by default (you can add your own easily if yours is not supported by default).

What browsers are supported?


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

What are the most recent changes?


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

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 email, as follows:

  1. ```markdown
  2. DOCTYPE html>
  3. ```

2. Include Files:


  1. ```markdown
  2. <link rel="stylesheet" href="dist/syntax.js.css" />
  3. <script src="dist/syntax.js"></script>
  4. <script src="dist/languages/syntax.javascript.js"></script>
  5. ```

3. Create DOM Container:


  1. ```markdown
  2. <div data-syntax-language="javascript">
  3.     var something = true;

  5.     if ( something ) {
  6.         console.log( "Output is written." ); // Comment
  7.         
  8.         /* Multi-line
  9.         comment */
  10.     }
  11. </div>

  13. <code data-syntax-language="javascript" data-syntax-options="{ 'showCopyButton': false }">
  14.     <pre>
  15.         var something = true;

  17.         if ( something ) {
  18.             console.log( "Output is written." ); // Comment
  19.             
  20.             /* Multi-line
  21.             comment */
  22.         }
  23.     </pre>
  24. </code>
  25. ```

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

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

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.