Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smdn/smdn.libhighlightsharp
Syntax highlight library for .NET, a wrapper for 'Highlight' by André Simon.
https://github.com/smdn/smdn.libhighlightsharp
bindings csharp dotnet highlight syntax-highlighting wrapper-library
Last synced: about 1 month ago
JSON representation
Syntax highlight library for .NET, a wrapper for 'Highlight' by André Simon.
- Host: GitHub
- URL: https://github.com/smdn/smdn.libhighlightsharp
- Owner: smdn
- License: gpl-3.0
- Created: 2022-11-21T10:52:22.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T10:51:35.000Z (about 2 months ago)
- Last Synced: 2024-09-17T12:33:41.602Z (about 2 months ago)
- Topics: bindings, csharp, dotnet, highlight, syntax-highlighting, wrapper-library
- Language: C#
- Homepage: https://smdn.jp/works/libs/Smdn.LibHighlightSharp/
- Size: 30.4 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING.txt
Awesome Lists containing this project
README
[](https://github.com/smdn/Smdn.LibHighlightSharp/blob/main/COPYING.txt)
[](https://github.com/smdn/Smdn.LibHighlightSharp/actions/workflows/test.yml)
[](https://github.com/smdn/Smdn.LibHighlightSharp/actions/workflows/codeql-analysis.yml)
# Smdn.LibHighlightSharp
[Smdn.LibHighlightSharp](src/Smdn.LibHighlightSharp/) is a wrapper library for using André Simon's [Highlight](http://andre-simon.de/doku/highlight/en/highlight.php), the syntax highlighter, on .NET.
This package provides wrapper classes that make Highlight easy to handle from C#/VB.NET. This package depends on the package `Smdn.LibHighlightSharp.Bindings` described below to use native libraries of Highlight.
[Smdn.LibHighlightSharp.Bindings](src/Smdn.LibHighlightSharp.Bindings/) is a class library includes the bindings compiled directly from the sources generated by SWIG. It provides the wrapper classes that calls native code. The NuGet package also includes the native libraries (`.dll`/`.so`/`.dylib`) for each platforms.
The major and minor version numbers of this package corresponds to the version of the bundled Highlight native library and its SWIG bindings.
If you don't need the wrapper class provided by `Smdn.LibHighlightSharp`, you can directly use the bindings provided by `Smdn.LibHighlightSharp.Bindings`.
[Smdn.LibHighlightSharp.LangDefs](src/Smdn.LibHighlightSharp.LangDefs/) and [Smdn.LibHighlightSharp.Themes](src/Smdn.LibHighlightSharp.Themes/) are the packages that provide Highlight syntax files (`*.lang`) and theme files (`*.theme`).
The major and minor version numbers of these package corresponds to the version of the bundled Highlight's syntax files and theme files.
If you add references to these packages, the syntax and theme files will be copied to the output directory. If you prepare these files by yourself, you can omit reference to these packages.
|Assembly|Package|
| --- | --- |
|[Smdn.LibHighlightSharp](src/Smdn.LibHighlightSharp/)|[](https://www.nuget.org/packages/Smdn.LibHighlightSharp/)|
|[Smdn.LibHighlightSharp.Bindings](src/Smdn.LibHighlightSharp.Bindings/)|[](https://www.nuget.org/packages/Smdn.LibHighlightSharp.Bindings/)|
|[Smdn.LibHighlightSharp.LangDefs](src/Smdn.LibHighlightSharp.LangDefs/)|[](https://www.nuget.org/packages/Smdn.LibHighlightSharp.LangDefs/)|
|[Smdn.LibHighlightSharp.Themes](src/Smdn.LibHighlightSharp.Themes/)|[](https://www.nuget.org/packages/Smdn.LibHighlightSharp.Themes/)|
## Usage
### Syntax highlighting
First, add ``s to the project file.
```xml
```
Then write the code like below. The following example highlights and displays the code contained in a `string`.
```cs
using Smdn.LibHighlightSharp;
// Creates an instance that generates code highlighted as a HTML document.
using var hl = new Highlight(GeneratorOutputType.Html);
// Sets 'github' to the theme.
hl.SetTheme("github");
// Sets 'csharp' to the language/syntax of input code.
hl.SetSyntax("csharp");
// Sets other options
hl.Title = "Hello, world!";
hl.SetIncludeStyle(true);
// Generates the highlighted code from string.
var input = @"using System;
Console.WriteLine(""Hello, world!"");";
Console.WriteLine(hl.Generate(input));
```
The generated HTML is displayed as follows.
See the projects in the [examples](./examples/) directory for more usages.
### Syntax and theme
Highlight supports syntax highlighting for various languages. Various color schemes are also available. You can use these **syntaxes** and **themes** by calling `SetSyntax` and `SetTheme` with its names.
As of Highlight v4.4, The following syntax and themes are available.
List of syntaxes (Provided by `Smdn.LibHighlightSharp.LangDefs` v4.4.0)
|Name |Description |
|----------------|------------------------------------------------|
|abap |ABAP/4 |
|abap4 |ABAP/4 |
|abc |ABC |
|abnf |Advanced Backus-Naur Form |
|actionscript |ActionScript |
|ada |ADA95 |
|agda |Agda |
|alan |ALAN Interactive Fiction Language |
|algol |ALGOL 68 |
|ampl |AMPL |
|amtrix |AMTrix |
|applescript |AppleScript |
|arc |Arc |
|arm |ARM |
|as400cl |AS/400 CL |
|ascend |ASCEND |
|asciidoc |AsciiDoc |
|asp |Active Server Pages |
|aspect |Abstract |
|assembler |Generic Assembler |
|ats |Applied Type System |
|autohotkey |AutoHotKey |
|autoit |AutoIt |
|avenue |Avenue |
|awk |(G)AWK |
|ballerina |Ballerina |
|bat |MS DOS Batch |
|bbcode |BBcode |
|bcpl |BCPL |
|bibtex |BibTeX |
|biferno |Biferno |
|bison |Bison |
|blitzbasic |Blitz Basic |
|bms |BM Script |
|bnf |Backus-Naur Form |
|boo |Boo |
|c |C and C++ |
|carbon |Carbon |
|ceylon |Ceylon |
|charmm |Charmm |
|chill |CHILL |
|chpl |Chapel |
|clean |Clean |
|clearbasic |ClearBasic |
|clipper |Clipper |
|clojure |Clojure |
|clp |Clips |
|cmake |CMake |
|cobol |COBOL |
|coffee |Coffeescript |
|coffeescript |Coffeescript |
|coldfusion |ColdFusion MX |
|conf |Generic config files |
|critic |CriticMarkup |
|crk |Crack |
|crystal |Crystal |
|cs_block_regex |Coffeescript Block Regex |
|csharp |C# |
|css |CSS |
|d |D |
|dart |Dart |
|delphi |delphi |
|diff |Diff |
|docker |Dockerfile |
|dockerfile |Dockerfile |
|dts |Device Tree Source |
|dylan |Dylan |
|ebnf |Extended Backus-Naur Form |
|ebnf2 |EBNF2 |
|eiffel |Eiffel |
|elixir |Elixir |
|email |E-Mail treated as Markup |
|erb |ERB Templates |
|erlang |Erlang |
|euphoria |Euphoria |
|exapunks |EXAPUNKS |
|excel |Excel Formulas |
|express |Express |
|fame |FAME |
|fasm |fasm |
|felix |Felix |
|fish |Fish |
|fortran77 |Fortran 77 |
|fortran90 |Fortran 90 |
|frink |Frink |
|fsharp |F# |
|fstab |fstab config file |
|fx |Java FX |
|gambas |Gambas |
|gdb |gdb |
|gdscript |GDScript |
|go |Go |
|graphviz |Graphviz |
|haml |Haml (HTML Abstraction Markup Language) |
|haskell |Haskell |
|haxe |haXe |
|hcl |Hecl |
|html |HTML |
|httpd |Apache Config |
|hugo |Hugo |
|icon |Icon |
|idl |IDL |
|idlang |Interactive Data Language |
|inc_luatex |Lua (for LuaTeX) |
|informix |Informix |
|ini |INI |
|innosetup |Inno Setup |
|interlis |INTERLIS |
|io |IO |
|jam |Jam |
|jasmin |Jasmin |
|java |Java |
|javascript |Javascript |
|js_regex |Javascript Regex |
|js |Javascript |
|json |JSON |
|jsp |JavaServer Pages |
|jsx |JSX |
|julia |Julia |
|kotlin |Kotlin |
|ldif |LDAP |
|less |Less |
|lhs |Haskell LHS |
|lilypond |Lilypond |
|limbo |Limbo |
|lindenscript |Linden Script |
|lisp |Lisp |
|logtalk |Logtalk |
|lotos |Lotos |
|lotus |Lotus |
|lua |Lua |
|luban |Luban |
|make |Make |
|makefile |Make |
|maple |Maple |
|markdown |GitHub Flavored Markdown |
|matlab |Matlab |
|maya |Maya |
|md |GitHub Flavored Markdown |
|mercury |Mercury |
|meson |Meson |
|miranda |Miranda |
|mod2 |Modula2 |
|mod3 |Modula3 |
|modelica |Modelica |
|moon |MoonScript |
|ms |MaxScript |
|msl |mIRC Scripting |
|mssql |MSSQL |
|mxml |Magic eXtensible Markup |
|n3 |Notation3 (N3), N-Triples, Turtle, SPARQL |
|nasal |Nasal |
|nbc |NeXT Byte Codes |
|nemerle |Nemerle |
|netrexx |NetRexx |
|nginx |Nginx configuration |
|nice |Nice |
|nim |Nim |
|nix |Nix Expression Language |
|nsis |NSIS |
|nxc |Not eXactly C |
|oberon |Oberon |
|objc |Objective C |
|ocaml |Objective Caml |
|octave |Octave |
|oorexx |OpenObjectRexx |
|org |Emacs Org-Mode |
|os |Object Script |
|oz |Oz |
|paradox |Paradox |
|pas |Pascal |
|pdf |Portable Document Format |
|perl |Perl |
|php |PHP |
|pike |Pike |
|pl1 |PL/1 |
|plperl |PL/Perl |
|plpython |PL/Python |
|pltcl |PL/Tcl |
|po |PO translation |
|polygen |Polygen |
|pony |Pony |
|pov |POV-Ray |
|powershell |Microsoft PowerShell |
|pro |Prolog |
|progress |Progress |
|ps |PostScript |
|ps1 |Microsoft PowerShell |
|psl |PATROL |
|pure |Pure |
|purebasic |PureBASIC |
|purescript |PureScript |
|pyrex |Pyrex |
|python |Python |
|q |Qore |
|qmake |QMake Project |
|qml |QML |
|qu |Qu |
|r |R |
|rebol |Rebol |
|rego |Rego |
|rexx |Rexx |
|rnc |Relax NG |
|rpg |RPG |
|rpl |RPL Programming Language |
|rs |Rust |
|rst |reStructured Text |
|ruby |Ruby |
|rust |Rust |
|s |PowerPC Assembler |
|sam |Sequence Alignment Map (use with sam_seq.lua plug-in)|
|sas |SAS |
|scad |OpenSCAD |
|scala |Scala |
|scilab |Scilab |
|scss |Sass/SCSS |
|sh |Bash |
|shellscript |Bash |
|slim |Slim (experimental) |
|small |SMALL |
|smalltalk |Smalltalk |
|sml |Standard ML |
|snmp |SNMP |
|snobol |SNOBOL |
|solidity |Solidity |
|spec |RPM Spec |
|spn |SPIN SQL |
|sql |PL/SQL |
|squirrel |Squirrel |
|styl |Stylus |
|svg |SVG |
|swift |Swift |
|sybase |Sybase SQL |
|tcl |Tcl/Tk |
|tcsh |TCSH |
|terraform |Terraform |
|tex |TeX and LaTeX |
|toml |TOML |
|ts |TypeScript |
|tsql |Transact-SQL |
|tsx |TSX (TypeScript with React) |
|ttcn3 |TTCN3 |
|txt |Plain text |
|typescript |TypeScript |
|upc |UPC (and C, technically) |
|vala |Vala |
|vb |Visual Basic |
|verilog |Verilog |
|vhd |VHDL |
|vimscript |vimscript |
|vue |vue.js (beta) |
|wat |Web Assembly Text |
|whiley |Whiley |
|wren |Wren |
|xml |XML |
|xpp |SuperX++ |
|yaiff |Yaiff |
|yaml |Ansible YAML |
|yang |Yang |
|zig |Zig |
|znn | |
List of themes (Provided by `Smdn.LibHighlightSharp.Themes` v4.4.0)
|Name |Description |
|------------------------------|------------------------------------------------|
|acid |Acid |
|aiseered |vim aiseered |
|andes |Andes |
|anotherdark |vim anotherdark |
|autumn |vim autumn |
|baycomb |vim baycomb |
|bclear |vim bclear |
|biogoo |vim biogoo |
|bipolar |Bipolar |
|blacknblue |Black And Blue |
|bluegreen |vim blue and green |
|breeze |vim breeze |
|bright |Bright |
|camo |vim camo |
|candy |vim candy |
|clarity |vim clarity |
|dante |vim dante |
|darkblue |Dark Blue |
|darkbone |vim dark bone |
|darkness |Darkness |
|darkplus |vscode darkplus |
|darkslategray |vim darkslategray |
|darkspectrum |vim darkspectrum |
|denim |vim denim |
|duotone-dark-earth |DuoTone Dark Earth |
|duotone-dark-forest |DuoTone Dark Forest |
|duotone-dark-sea |DuoTone Dark Sea |
|duotone-dark-sky |DuoTone Dark Sky |
|duotone-dark-space |DuoTone Dark Space |
|dusk |vim dusk |
|earendel |vim earendel |
|easter |Easter |
|edit-anjuta |Anjuta IDE |
|edit-bbedit |BBEdit Classic |
|edit-eclipse |Eclipse IDE |
|edit-emacs |Emacs Editor |
|edit-fasm |FASM Editor |
|edit-flashdevelop |FlashDevelop |
|edit-gedit |Gedit Editor |
|edit-godot |Godot Engine |
|edit-jedit |jEdit Editor |
|edit-kwrite |Kwrite Editor |
|edit-matlab |Matlab Editor |
|edit-msvs2008 |Visual Studio IDE |
|edit-nedit |Nedit Editor |
|edit-purebasic |PureBASIC |
|edit-vim-dark |Vim Dark Editor |
|edit-vim |Vim Editor |
|edit-xcode |XCode IDE |
|ekvoli |vim ekvoli |
|fine_blue |vim fine_blue |
|fineblue |vim fine_blue |
|freya |vim freya |
|fruit |vim fruit |
|github |Github Source View |
|golden |Golden |
|greenlcd |Green LCD |
|kellys |vim kellys |
|leo |vim leo256 |
|lucretia |Lucretia |
|manxome |vim manxome |
|maroloccio |vim maroloccio |
|matrix |vim Matrix |
|moe |Moe |
|molokai |vim molokai |
|moria |vim moria |
|navajo-night |vim navajo-night |
|navy |Navy |
|neon |vim neon |
|night |vim night |
|nightshimmer |vim nightshimmer |
|nord |Nord |
|nuvola |vim nuvola |
|olive |vim olive |
|orion |Orion |
|oxygenated |oXygenated rnc |
|pablo |Pablo |
|peaksea |vim peaksea |
|print |Print |
|rand01 |Random 01 |
|rdark |vim rdark |
|relaxedgreen |vim relaxedgreen |
|rootwater |vim rootwater |
|seashell |Seashell |
|solarized-dark |Solarized Dark |
|solarized-light |Solarized Light |
|sourceforge |Sourceforge.net |
|tabula |vim tabula |
|tcsoft |vim TCSoft |
|the |the |
|vampire |Vampire |
|whitengrey |White and Grey |
|xoria256 |vim xoria256 |
|zellner |Zellner |
|zenburn |vim zenburn |
|zmrok |vim zmrok |
|Name (Base16) |Description |
|------------------------------|------------------------------------------------|
|3024 |Base16 3024 |
|apathy |Base16 Apathy |
|ashes |Base16 Ashes |
|atelier-cave-light |Base16 Atelier Cave Light |
|atelier-cave |Base16 Atelier Cave |
|atelier-dune-light |Base16 Atelier Dune Light |
|atelier-dune |Base16 Atelier Dune |
|atelier-estuary-light |Base16 Atelier Estuary Light |
|atelier-estuary |Base16 Atelier Estuary |
|atelier-forest-light |Base16 Atelier Forest Light |
|atelier-forest |Base16 Atelier Forest |
|atelier-heath-light |Base16 Atelier Heath Light |
|atelier-heath |Base16 Atelier Heath |
|atelier-lakeside-light |Base16 Atelier Lakeside Light |
|atelier-lakeside |Base16 Atelier Lakeside |
|atelier-plateau-light |Base16 Atelier Plateau Light |
|atelier-plateau |Base16 Atelier Plateau |
|atelier-savanna-light |Base16 Atelier Savanna Light |
|atelier-savanna |Base16 Atelier Savanna |
|atelier-seaside-light |Base16 Atelier Seaside Light |
|atelier-seaside |Base16 Atelier Seaside |
|atelier-sulphurpool-light |Base16 Atelier Sulphurpool Light |
|atelier-sulphurpool |Base16 Atelier Sulphurpool |
|bespin |Base16 Bespin |
|brewer |Base16 Brewer |
|bright |Base16 Bright |
|brushtrees-dark |Base16 Brush Trees Dark |
|brushtrees |Base16 Brush Trees |
|chalk |Base16 Chalk |
|circus |Base16 Circus |
|classic-dark |Base16 Classic Dark |
|classic-light |Base16 Classic Light |
|codeschool |Base16 Codeschool |
|cupcake |Base16 Cupcake |
|cupertino |Base16 Cupertino |
|darktooth |Base16 Darktooth |
|default-dark |Base16 Default Dark |
|default-light |Base16 Default Light |
|dracula |Base16 Dracula |
|eighties |Base16 Eighties |
|embers |Base16 Embers |
|flat |Base16 Flat |
|github |Base16 Github |
|google-dark |Base16 Google Dark |
|google-light |Base16 Google Light |
|grayscale-dark |Base16 Grayscale Dark |
|grayscale-light |Base16 Grayscale Light |
|greenscreen |Base16 Green Screen |
|gruvbox-dark-hard |Base16 Gruvbox dark, hard |
|gruvbox-dark-medium |Base16 Gruvbox dark, medium |
|gruvbox-dark-pale |Base16 Gruvbox dark, pale |
|gruvbox-dark-soft |Base16 Gruvbox dark, soft |
|gruvbox-light-hard |Base16 Gruvbox light, hard |
|gruvbox-light-medium |Base16 Gruvbox light, medium |
|gruvbox-light-soft |Base16 Gruvbox light, soft |
|harmonic-dark |Base16 Harmonic16 Dark |
|harmonic-light |Base16 Harmonic16 Light |
|hopscotch |Base16 Hopscotch |
|ia-dark |Base16 iA Dark |
|ia-light |Base16 iA Light |
|icy |Base16 Icy |
|irblack |Base16 IR Black |
|isotope |Base16 Isotope |
|macintosh |Base16 Macintosh |
|marrakesh |Base16 Marrakesh |
|materia |Base16 Materia |
|material-darker |Base16 Material Darker |
|material-lighter |Base16 Material Lighter |
|material-palenight |Base16 Material Palenight |
|material-vivid |Base16 Material Vivid |
|material |Base16 Material |
|mellow-purple |Base16 Mellow Purple |
|mexico-light |Base16 Mexico Light |
|mocha |Base16 Mocha |
|monokai |Base16 Monokai |
|nord |Base16 Nord |
|ocean |Base16 Ocean |
|oceanicnext |Base16 OceanicNext |
|one-light |Base16 One Light |
|onedark |Base16 OneDark |
|outrun-dark |Base16 Outrun Dark |
|paraiso |Base16 Paraiso |
|phd |Base16 PhD |
|pico |Base16 Pico |
|pop |Base16 Pop |
|porple |Base16 Porple |
|railscasts |Base16 Railscasts |
|rebecca |Base16 Rebecca |
|seti |Base16 Seti UI |
|shapeshifter |Base16 Shapeshifter |
|snazzy |Base16 Snazzy |
|solarflare |Base16 Solar Flare |
|solarized-dark |Base16 Solarized Dark |
|solarized-light |Base16 Solarized Light |
|spacemacs |Base16 Spacemacs |
|summerfruit-dark |Base16 Summerfruit Dark |
|summerfruit-light |Base16 Summerfruit Light |
|tomorrow-night |Base16 Tomorrow Night |
|tomorrow |Base16 Tomorrow |
|tube |Base16 London Tube |
|twilight |Base16 Twilight |
|unikitty-dark |Base16 Unikitty Dark |
|unikitty-light |Base16 Unikitty Light |
|unikitty-reversible |Base16 Unikitty Reversible |
|woodland |Base16 Woodland |
|xcode-dusk |Base16 XCode Dusk |
|zenburn |Base16 Zenburn |
### Combining different versions
You can combine the different versions of bindings/syntaxes/themes, as in the following example.
```xml
```
`Smdn.LibHighlightSharp` and `Smdn.LibHighlightSharp.Bindings` can be combined with any version.
```xml
```
Feature that is version-specific, is resolved by dynamic binding (`System.Dynamic`). Calls to version-specific features will throw an exception or be simply ignored at runtime.
## Troubleshooting
### Warning `NETSDK1206` / Simplified RID issues (.NET 8.0)
Starting with .NET 8.0, Runtime Identifiers (RID) such as `ubuntu.22.04-x64` have been simplified and it is recommended to use `linux-x64` instead.
Some older versions of `Smdn.LibHighlightSharp.Bindings` packages do not contain native binaries targeting `linux-x64`.
This may result in native binaries not being deployed and `DllNotFoundException` being thrown at runtime. Also, a warning `NETSDK1206` is displayed at build time.
```
$ dotnet build
/usr/share/dotnet/sdk/8.0.101/Sdks/Microsoft.NET.Sdk/targets/Microsoft.NET.Sdk.targets(284,5): warning NETSDK1206: Found version-specific or distribution-specific runtime identifier(s): ubuntu.20.04-x64, ubuntu.22.04-x64. Affected libraries: Smdn.LibHighlightSharp.Bindings. In .NET 8.0 and higher, assets for version-specific and distribution-specific runtime identifiers will not be found by default. See https://aka.ms/dotnet/rid-usage for details. [/home/runner/work/Smdn.LibHighlightSharp/Smdn.LibHighlightSharp/tests/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings.Tests.csproj::TargetFramework=net8.0]
$ dotnet run
System.TypeInitializationException: The type initializer for 'Smdn.LibHighlightSharp.Bindings.highlightPINVOKE' threw an exception.
---> System.TypeInitializationException: The type initializer for 'SWIGExceptionHelper' threw an exception.
---> System.DllNotFoundException: Unable to load shared library 'highlight-v4_10_0_0' or one of its dependencies. In order to help diagnose loading problems, consider using a tool like strace. If you're using glibc, consider setting the LD_DEBUG environment variable:
```
To avoid this problem, use the version of `Smdn.LibHighlightSharp.Bindings` that ships with `linux-x64` native binaries, or apply the workaround given in [issue #141](https://github.com/smdn/Smdn.LibHighlightSharp/issues/141).
### `DllImport` issues
If the exception `TypeInitializationException` or `DllNotFoundException` occurs like below, the native library may not have been deployed correctly.
```text
Unhandled exception. System.TypeInitializationException: The type initializer for 'Smdn.LibHighlightSharp.Bindings.highlightPINVOKE' threw an exception.
---> System.TypeInitializationException: The type initializer for 'SWIGExceptionHelper' threw an exception.
---> System.DllNotFoundException: Unable to load shared library 'highlight-v4_4_0_0' or one of its dependencies. In order to help diagnose loading problems, consider setting the LD_DEBUG environment variable: libhighlight-v4_4_0_0: cannot open shared object file: No such file or directory
```
First, make sure that the package `Smdn.LibHighlightSharp.NativeBinaries` has been added to your project correctly.
```xml
```
For Linux or macOS, make sure **Lua 5.3** is installed on your system.
```sh
# install Lua 5.3 using apt-get
sudo apt-get install liblua5.3
# install Lua using Homebrew
brew install [email protected]
```
If you have copied or moved the output files generated by `dotnet build` or `dotnet publish` to another location, make sure that the native libraries are correctly deployed also.
One of the following native library files must be located in the same directory as the executables or in the `runtimes//native/` directory.
- highlight-v*X*_*Y*_0_0.dll (Windows)
- libhighlight-v*X*_*Y*_0_0.so (Linux)
- libhighlight-v*X*_*Y*_0_0.dylib (macOS)
When running on Windows, make sure that the **lua53.dll** is also deployed in the same directory.
# Documents
## API list
The APIs exposed by each package are listed in [doc/api-list/](doc/api-list/).
## Build instructions
See [src/README.md](src/README.md) for details.
# For contributers
Contributions are appreciated!
If there's a feature you would like to add or a bug you would like to fix, please read [Contribution guidelines](./CONTRIBUTING.md) and create an Issue or Pull Request.
IssueやPull Requestを送る際は、[Contribution guidelines](./CONTRIBUTING.md)をご覧頂ください。 可能なら英語が望ましいですが、日本語で構いません。
# Notice
This software is licensed under [the GNU General Public License v3.0](./COPYING.txt).
This software uses the following components.
## Highlight
The bundled file copied or generated from [Highlight](http://andre-simon.de/doku/highlight/en/highlight.php) is licensed under the GNU General Public License v3.0 (see [COPYING.txt](./COPYING.txt)).
- Source: https://gitlab.com/saalen/highlight.git
## Lua (for Windows only)
For Windows, the package [Smdn.LibHighlightSharp.Bindings](src/Smdn.LibHighlightSharp.Bindings/) bundles [Lua](https://www.lua.org/) Windows DLL which Highlight depends, and is licensed under the MIT License:
```text
Copyright © 1994–2021 Lua.org, PUC-Rio.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
- Source: https://sourceforge.net/projects/luabinaries/