okami.mom/glamour

git clone https://git.nkp.pet/okami.mom/glamour

Ayman BagabasMerge pull request #408 from charmbracelet/v2-expcf874d7

main
30.5 KiB40 linesraw
1
2   Gold                                                                       
3                                                                              
4  Render markdown on the CLI, with pizzazz!                                   
5                                                                              
6  ## What is it?                                                              
7                                                                              
8  Gold is a Golang library that allows you to use JSON based stylesheets to   
9  render Markdown files in the terminal. Just like CSS, you can define color  
10  and style attributes on Markdown elements. The difference is that you use   
11  ANSI color and terminal codes instead of CSS properties and hex colors.     
12                                                                              
13  ## Usage                                                                    
14                                                                              
15  See ]8;id=2016159207;cmd/gold/cmd/gold]8;; ]8;id=2016159207;cmd/gold//cmd/gold/]8;;.                                                    
16                                                                              
17  ## Example Output                                                           
18                                                                              
19  Image: ]8;id=1366020261;https://github.com/charmbracelet/gold/raw/master/styles/gallery/dark.pngGold Dark Style]8;; →                                                    
20  ]8;id=1366020261;https://github.com/charmbracelet/gold/raw/master/styles/gallery/dark.pnghttps://github.com/charmbracelet/gold/raw/master/styles/gallery/dark.png]8;;    
21                                                                              
22  Check out the ]8;id=1154245156;https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.mdGold Style Gallery]8;;                                            
23  ]8;id=1154245156;https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.mdhttps://github.com/charmbracelet/gold/blob/master/styles/gallery/README.md]8;;! 
24                                                                              
25  ## Colors                                                                   
26                                                                              
27  Currently  gold  uses the ]8;id=1194993659;https://godoc.org/github.com/logrusorgru/aurora#IndexAurora ANSI colors]8;;                                
28  ]8;id=1194993659;https://godoc.org/github.com/logrusorgru/aurora#Indexhttps://godoc.org/github.com/logrusorgru/aurora#Index]8;;.                      
29                                                                              
30  ## Development                                                              
31                                                                              
32  Style definitions located in  styles/  can be embedded into the binary by   
33  running ]8;id=2721212073;https://github.com/rakyll/statikstatik]8;; ]8;id=2721212073;https://github.com/rakyll/statikhttps://github.com/rakyll/statik]8;;:                            
34                                                                              
35    statik -f -src styles -include "*.json"                                   
36                                                                              
37  You can re-generate screenshots of all available styles by running          
38   gallery.sh . This requires  termshot  and  pngcrush  installed on your     
39  system!                                                                     
40