brick-skylighting: Show syntax-highlighted text in your Brick UI

[ bsd3, graphics, library ] [ Propose Tags ]

This package provides a module to use Skylighting to perform syntax highlighting and display the results in Brick-based interfaces.


[Skip to Readme]
Versions 0.1, 0.2, 0.3
Change log CHANGELOG.md
Dependencies base (<=5), brick (>=0.39), brick-skylighting, containers, skylighting-core (>=0.7), text, vty (>=5.23.1) [details]
License BSD-3-Clause
Copyright Jonathan Daugherty 2018
Author Jonathan Daugherty
Maintainer cygnus@foobox.com
Category Graphics
Home page https://github.com/jtdaugherty/brick-skylighting/
Bug tracker https://github.com/jtdaugherty/brick-skylighting/issues
Source repo head: git clone git://github.com/jtdaugherty/brick-skylighting.git
Uploaded by JonathanDaugherty at Mon Aug 13 23:13:42 UTC 2018
Distributions NixOS:0.3
Executables brick-skylighting-demo
Downloads 347 total (35 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-08-13 [all 1 reports]
Hackage Matrix CI

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
demos

Build demonstration programs

DisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for brick-skylighting-0.3

[back to package description]

brick-skylighting

This package extends the brick library with syntax highlighting support using the Skylighting library.

See the Haddock documentation for Brick.Widgets.Skylighting for API details, and see the demonstration program in programs for a complete working example.

Note: this library requires its users to provide syntax highlighting definitions. For that, there are two choices:

  • Obtain XML specifications from e.g. the skylighting-core sources, then bundle these with your program files. Those files are GPL-licensed, so this option is preferable when you want to ship these GPL-licensed files with your program without the GPL infecting the license of your application.

  • Use the compiled-in syntax specifications in the skylighting package. This option is preferable if you are okay with a GPL-licensed dependency (i.e. if your application is also GPL'd) and you especially want to avoid having to bundle the XML files with your application or avoid the runtime loading of such files.