https://github.com/jtdaugherty/brick-skylighting

Display syntax-highlighted text in Brick user interfaces
https://github.com/jtdaugherty/brick-skylighting

brick haskell highlighting skylighting syntax terminal tui vty

Last synced: 3 months ago
JSON representation

Display syntax-highlighted text in Brick user interfaces

• Host: GitHub
• URL: https://github.com/jtdaugherty/brick-skylighting
• Owner: jtdaugherty
• License: bsd-3-clause
• Created: 2018-01-23T05:50:54.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-08T22:38:38.000Z (over 2 years ago)
• Last Synced: 2024-04-25T21:45:21.661Z (10 months ago)
• Topics: brick, haskell, highlighting, skylighting, syntax, terminal, tui, vty
• Language: Haskell
• Size: 119 KB
• Stars: 12
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

brick-skylighting

=================

![](images/demo.png)

This package extends the [brick](https://github.com/jtdaugherty/brick)

library with syntax highlighting support using the

[Skylighting](https://github.com/jgm/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.