github.com/charmbracelet/glamour@v0.7.0/testdata/readme.markdown.in (about)

     1  # Gold
     2  
     3  Render markdown on the CLI, with _pizzazz_!
     4  
     5  ## What is it?
     6  
     7  Gold is a Golang library that allows you to use JSON based stylesheets to
     8  render Markdown files in the terminal. Just like CSS, you can define color and
     9  style attributes on Markdown elements. The difference is that you use ANSI
    10  color and terminal codes instead of CSS properties and hex colors.
    11  
    12  ## Usage
    13  
    14  See [cmd/gold](cmd/gold/).
    15  
    16  ## Example Output
    17  
    18  ![Gold Dark Style](https://github.com/charmbracelet/gold/raw/master/styles/gallery/dark.png)
    19  
    20  Check out the [Gold Style Gallery](https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.md)!
    21  
    22  ## Colors
    23  
    24  Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).
    25  
    26  <!-- comments should be ignored -->
    27  
    28  ## Development
    29  
    30  Style definitions located in `styles/` can be embedded into the binary by
    31  running [statik](https://github.com/rakyll/statik):
    32  
    33  ```console
    34  statik -f -src styles -include "*.json"
    35  ```
    36  
    37  <!--
    38  multiline comments should also be ignored
    39  this is one comment with
    40  more than one
    41  line
    42  
    43  yup
    44  -->
    45  
    46  You can re-generate screenshots of all available styles by running `gallery.sh`.
    47  This requires `termshot` and `pngcrush` installed on your system!