-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from williamtroup/0.7.0
0.7.0
- Loading branch information
Showing
26 changed files
with
456 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| /.vs | ||
| /.vscode | ||
| .DS_Store | ||
| *.nupkg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| # Syntax.js v0.7.0 | ||
|
|
||
| [](https://twitter.com/intent/tweet?text=Syntax.js%2C%20a%20free%20JavaScript%20syntax%20highlighter&url=https://github.com/williamtroup/Syntax.js&hashtags=javascript,syntax,highlighter) | ||
| [](https://www.npmjs.com/package/jsyntax.js) | ||
| [](https://www.nuget.org/packages/jSyntax.js/) | ||
| [](https://github.com/williamtroup/Syntax.js/blob/main/LICENSE.txt) | ||
| [](https://github.com/williamtroup/Syntax.js/discussions) | ||
| [](https://github.com/williamtroup) | ||
|
|
||
| > A lightweight, and easy-to-use, JavaScript library for code syntax highlighting! | ||
|
|
||
| ## 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, options are updated, etc, etc.). | ||
| - Fully configurable. | ||
|
|
||
|
|
||
| ## 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](https://github.com/williamtroup/Syntax.js/blob/main/docs/CHANGE_LOG.md). | ||
|
|
||
|
|
||
| ## 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: | ||
|
|
||
| ```markdown | ||
| <!DOCTYPE html> | ||
| ``` | ||
|
|
||
| ### 2. Include Files: | ||
|
|
||
| ```markdown | ||
| <link rel="stylesheet" href="dist/syntax.js.css" /> | ||
| <script src="dist/syntax.js"></script> | ||
| ``` | ||
|
|
||
| ### 3. Create DOM Container: | ||
|
|
||
| ```markdown | ||
| <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="{ 'showCopyButton': false }"> | ||
| <pre> | ||
| var something = true; | ||
|
|
||
| if ( something ) { | ||
| console.log( "Output is written." ); // Comment | ||
|
|
||
| /* Multi-line | ||
| comment */ | ||
| } | ||
| </pre> | ||
| </code> | ||
| ``` | ||
|
|
||
| To see a list of all the available options you can use for "data-syntax-options", click [here](https://github.com/williamtroup/Syntax.js/blob/main/docs/OPTIONS.md). | ||
|
|
||
|
|
||
| ### 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](https://github.com/williamtroup/Syntax.js/blob/main/docs/FUNCTIONS.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /*! Syntax.js v0.7.0 | (c) Bunoon | MIT License */ | ||
| $syntax.addLanguage( "c", { | ||
| keywords: [ | ||
| "auto", | ||
| "else", | ||
| "long", | ||
| "switch", | ||
| "break", | ||
| "enum", | ||
| "register", | ||
| "typedef", | ||
| "case", | ||
| "extern", | ||
| "return", | ||
| "union", | ||
| "char", | ||
| "float", | ||
| "short", | ||
| "unsigned", | ||
| "const", | ||
| "for", | ||
| "signed", | ||
| "void", | ||
| "continue", | ||
| "goto", | ||
| "sizeof", | ||
| "volatile", | ||
| "default", | ||
| "if", | ||
| "static", | ||
| "while", | ||
| "do", | ||
| "int", | ||
| "struct", | ||
| "_Packed", | ||
| "double" | ||
| ], | ||
| comment: "//", | ||
| multiLineComment: [ "/*", "*/" ] | ||
| } ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /*! Syntax.js v0.7.0 | (c) Bunoon | MIT License */ | ||
| $syntax.addLanguage( "javascript", { | ||
| keywords: [ | ||
| "abstract", | ||
| "arguments", | ||
| "await", | ||
| "boolean", | ||
| "break", | ||
| "byte", | ||
| "case", | ||
| "catch", | ||
| "char", | ||
| "class", | ||
| "const", | ||
| "continue", | ||
| "debugger", | ||
| "default", | ||
| "delete", | ||
| "do", | ||
| "double", | ||
| "else", | ||
| "enum", | ||
| "eval", | ||
| "export", | ||
| "extends", | ||
| "false", | ||
| "final", | ||
| "finally", | ||
| "float", | ||
| "for", | ||
| "function", | ||
| "goto", | ||
| "if", | ||
| "implements", | ||
| "import", | ||
| "in", | ||
| "instanceof", | ||
| "int", | ||
| "interface", | ||
| "let", | ||
| "long", | ||
| "native", | ||
| "new", | ||
| "null", | ||
| "package", | ||
| "private", | ||
| "protected", | ||
| "public", | ||
| "return", | ||
| "short", | ||
| "static", | ||
| "super", | ||
| "switch", | ||
| "synchronized", | ||
| "this", | ||
| "throw", | ||
| "throws", | ||
| "transient", | ||
| "true", | ||
| "try", | ||
| "typeof", | ||
| "var", | ||
| "void", | ||
| "volatile", | ||
| "while", | ||
| "with", | ||
| "yield" | ||
| ], | ||
| comment: "//", | ||
| multiLineComment: [ | ||
| "/*", | ||
| "*/" | ||
| ] | ||
| } ); |
Oops, something went wrong.