mirror of
https://github.com/rwinkhart/glamour-temp-MUTN.git
synced 2026-09-03 07:27:19 -04:00
Update and pair down README
This commit is contained in:
@@ -1,34 +1,5 @@
|
||||
# Glamour
|
||||
|
||||
Render markdown on the CLI, with _pizzazz_!
|
||||
|
||||
## What is it?
|
||||
|
||||
A Go library that lets you use JSON-based stylesheets to render Markdown files
|
||||
in the terminal. Just like CSS, you can define color and style attributes on
|
||||
Markdown elements. The difference is that you use ANSI color and terminal codes
|
||||
instead of CSS properties and hex colors.
|
||||
|
||||
Available as a library and on the CLI.
|
||||
|
||||
## Example Output
|
||||
|
||||

|
||||
|
||||
Check out the [Glamour Style Gallery](https://github.com/charmbracelet/glamour/blob/master/styles/gallery/README.md)!
|
||||
|
||||
## Colors
|
||||
|
||||
Currently `glamour` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).
|
||||
|
||||
## Development
|
||||
|
||||
Style definitions located in `styles/` can be embedded into the binary with
|
||||
[statik](https://github.com/rakyll/statik):
|
||||
|
||||
```console
|
||||
statik -f -src styles -include "*.json"
|
||||
```
|
||||
|
||||
You can re-generate screenshots of all available styles running `gallery.sh`.
|
||||
This requires `termshot`, `convert` and `pngcrush` installed on your system!
|
||||
Coming soon. For now, check out
|
||||
[Gold](https://github.com/charmbracelet/gold), the CLI implementation of this
|
||||
package.
|
||||
|
||||
Reference in New Issue
Block a user