diff --git a/examples.sh b/examples.sh new file mode 100755 index 0000000..0a5c9be --- /dev/null +++ b/examples.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +set -e + +for element in ./styles/examples/*.md; do + echo "Generating screenshot for element ${element}" + basename="`basename -s .md ${element}`" + stylename="${basename}.style" + filename="${basename}.png" + + ./termshot -o ./styles/examples/ -f "$filename" ./cmd/gold/gold -s ./styles/examples/${stylename} ${element} + pngcrush -ow "./styles/examples/$filename" +done diff --git a/styles/README.md b/styles/README.md index a8a419a..393c405 100644 --- a/styles/README.md +++ b/styles/README.md @@ -118,6 +118,9 @@ Style: } ``` +Output: +![Heading Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/heading.png) + ## text The `text` element represents a block of text. @@ -218,6 +221,9 @@ Style: } ``` +Output: +![List Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/list.png) + ## enumeration The `enumeration` element represents an item in ordered lists. @@ -257,6 +263,9 @@ Style: } ``` +Output: +![Enumeration Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/enumeration.png) + ## link The `link` element represents a link. @@ -298,6 +307,9 @@ Style: } ``` +Output: +![Link Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/link.png) + ## link_text The `link_text` element represents the text associated with a link. @@ -371,6 +383,9 @@ Style: } ``` +Output: +![Image Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/image.png) + ## image_text The `image_text` element represents the text associated with an image. @@ -435,6 +450,9 @@ Style: } ``` +Output: +![Code Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/code.png) + ## code_block The `code_block` element represents a block of code. @@ -463,6 +481,9 @@ Style: } ``` +Output: +![Code Block Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/code_block.png) + ## table The `table` element represents a table of data. @@ -497,6 +518,9 @@ Style: } ``` +Output: +![Table Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/table.png) + ## emph The `emph` element represents an emphasized text. @@ -535,6 +559,9 @@ Style: } ``` +Output: +![Emph Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/emph.png) + ## strong The `strong` element represents important text. @@ -573,6 +600,9 @@ Style: } ``` +Output: +![Strong Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/strong.png) + ## hr The `hr` element represents a horizontal rule. @@ -611,6 +641,9 @@ Style: } ``` +Output: +![hr Example](https://github.com/charmbracelet/gold/raw/master/styles/examples/hr.png) + ## block_quote ## del ## softbreak diff --git a/styles/examples/code.md b/styles/examples/code.md new file mode 100644 index 0000000..aac3ca8 --- /dev/null +++ b/styles/examples/code.md @@ -0,0 +1 @@ +This is a `code`. diff --git a/styles/examples/code.png b/styles/examples/code.png new file mode 100644 index 0000000..7429021 Binary files /dev/null and b/styles/examples/code.png differ diff --git a/styles/examples/code.style b/styles/examples/code.style new file mode 100644 index 0000000..430161c --- /dev/null +++ b/styles/examples/code.style @@ -0,0 +1,5 @@ +{ + "code": { + "color": "200" + } +} diff --git a/styles/examples/code_block.md b/styles/examples/code_block.md new file mode 100644 index 0000000..9028382 --- /dev/null +++ b/styles/examples/code_block.md @@ -0,0 +1,3 @@ +``` +This is a code block. +``` diff --git a/styles/examples/code_block.png b/styles/examples/code_block.png new file mode 100644 index 0000000..af5f9b1 Binary files /dev/null and b/styles/examples/code_block.png differ diff --git a/styles/examples/code_block.style b/styles/examples/code_block.style new file mode 100644 index 0000000..ee735c3 --- /dev/null +++ b/styles/examples/code_block.style @@ -0,0 +1,7 @@ +{ + "code_block": { + "margin": 4, + "color": "200", + "theme": "solarized-dark" + } +} diff --git a/styles/examples/document.style b/styles/examples/document.style new file mode 100644 index 0000000..6703ccc --- /dev/null +++ b/styles/examples/document.style @@ -0,0 +1,8 @@ +{ + "document": { + "indent": 2, + "background_color": "234", + "prefix": "\n", + "suffix": "\n" + } +} diff --git a/styles/examples/emph.md b/styles/examples/emph.md new file mode 100644 index 0000000..878fcdf --- /dev/null +++ b/styles/examples/emph.md @@ -0,0 +1 @@ +This text is *emphasized*. diff --git a/styles/examples/emph.png b/styles/examples/emph.png new file mode 100644 index 0000000..46d1126 Binary files /dev/null and b/styles/examples/emph.png differ diff --git a/styles/examples/emph.style b/styles/examples/emph.style new file mode 100644 index 0000000..5b01e7b --- /dev/null +++ b/styles/examples/emph.style @@ -0,0 +1,5 @@ +{ + "emph": { + "italic": true + } +} diff --git a/styles/examples/enumeration.md b/styles/examples/enumeration.md new file mode 100644 index 0000000..52664fb --- /dev/null +++ b/styles/examples/enumeration.md @@ -0,0 +1,2 @@ +1. First Item +2. Second Item diff --git a/styles/examples/enumeration.png b/styles/examples/enumeration.png new file mode 100644 index 0000000..4a99468 Binary files /dev/null and b/styles/examples/enumeration.png differ diff --git a/styles/examples/enumeration.style b/styles/examples/enumeration.style new file mode 100644 index 0000000..2394bdd --- /dev/null +++ b/styles/examples/enumeration.style @@ -0,0 +1,10 @@ +{ + "list": { + "margin": 4, + "color": "15", + "background_color": "52" + }, + "enumeration": { + "prefix": ". " + } +} diff --git a/styles/examples/heading.md b/styles/examples/heading.md new file mode 100644 index 0000000..25eaf55 --- /dev/null +++ b/styles/examples/heading.md @@ -0,0 +1,5 @@ +# h1 + +## h2 + +### h3 diff --git a/styles/examples/heading.png b/styles/examples/heading.png new file mode 100644 index 0000000..989dbf0 Binary files /dev/null and b/styles/examples/heading.png differ diff --git a/styles/examples/heading.style b/styles/examples/heading.style new file mode 100644 index 0000000..92063d4 --- /dev/null +++ b/styles/examples/heading.style @@ -0,0 +1,17 @@ +{ + "heading": { + "margin": 4, + "color": "15", + "background_color": "57" + }, + "h1": { + "prefix": "=> ", + "suffix": " <=", + "margin": 2, + "bold": true, + "background_color": "69" + }, + "h2": { + "prefix": "# " + } +} diff --git a/styles/examples/hr.md b/styles/examples/hr.md new file mode 100644 index 0000000..ed97d53 --- /dev/null +++ b/styles/examples/hr.md @@ -0,0 +1 @@ +--- diff --git a/styles/examples/hr.png b/styles/examples/hr.png new file mode 100644 index 0000000..58e01c7 Binary files /dev/null and b/styles/examples/hr.png differ diff --git a/styles/examples/hr.style b/styles/examples/hr.style new file mode 100644 index 0000000..9810cc5 --- /dev/null +++ b/styles/examples/hr.style @@ -0,0 +1,5 @@ +{ + "hr": { + "prefix": "---" + } +} diff --git a/styles/examples/image.md b/styles/examples/image.md new file mode 100644 index 0000000..3be4dd9 --- /dev/null +++ b/styles/examples/image.md @@ -0,0 +1 @@ +![Image](https://charm.sh/logo.png). diff --git a/styles/examples/image.png b/styles/examples/image.png new file mode 100644 index 0000000..c030cc0 Binary files /dev/null and b/styles/examples/image.png differ diff --git a/styles/examples/image.style b/styles/examples/image.style new file mode 100644 index 0000000..e77d016 --- /dev/null +++ b/styles/examples/image.style @@ -0,0 +1,10 @@ +{ + "image": { + "color": "123", + "prefix": "[Image: ", + "suffix": "]" + }, + "image_text": { + "color": "8" + } +} diff --git a/styles/examples/link.md b/styles/examples/link.md new file mode 100644 index 0000000..3a56cbd --- /dev/null +++ b/styles/examples/link.md @@ -0,0 +1 @@ +This is a [link](https://charm.sh). diff --git a/styles/examples/link.png b/styles/examples/link.png new file mode 100644 index 0000000..c7d3e38 Binary files /dev/null and b/styles/examples/link.png differ diff --git a/styles/examples/link.style b/styles/examples/link.style new file mode 100644 index 0000000..9941dbf --- /dev/null +++ b/styles/examples/link.style @@ -0,0 +1,12 @@ +{ + "link": { + "color": "123", + "underline": true, + "prefix": "(", + "suffix": ")" + }, + "link_text": { + "color": "123", + "bold": true + } +} diff --git a/styles/examples/list.md b/styles/examples/list.md new file mode 100644 index 0000000..3187557 --- /dev/null +++ b/styles/examples/list.md @@ -0,0 +1,2 @@ +- First Item + - Nested List Item diff --git a/styles/examples/list.png b/styles/examples/list.png new file mode 100644 index 0000000..f677990 Binary files /dev/null and b/styles/examples/list.png differ diff --git a/styles/examples/list.style b/styles/examples/list.style new file mode 100644 index 0000000..280a1d8 --- /dev/null +++ b/styles/examples/list.style @@ -0,0 +1,10 @@ +{ + "list": { + "margin": 4, + "color": "15", + "background_color": "52" + }, + "item": { + "prefix": "• " + } +} diff --git a/styles/examples/paragraph.style b/styles/examples/paragraph.style new file mode 100644 index 0000000..13825d5 --- /dev/null +++ b/styles/examples/paragraph.style @@ -0,0 +1,7 @@ +{ + "paragraph": { + "margin": 4, + "color": "15", + "background_color": "235" + } +} diff --git a/styles/examples/strong.md b/styles/examples/strong.md new file mode 100644 index 0000000..72442e2 --- /dev/null +++ b/styles/examples/strong.md @@ -0,0 +1 @@ +This text is **strong**. diff --git a/styles/examples/strong.png b/styles/examples/strong.png new file mode 100644 index 0000000..121bc89 Binary files /dev/null and b/styles/examples/strong.png differ diff --git a/styles/examples/strong.style b/styles/examples/strong.style new file mode 100644 index 0000000..151984d --- /dev/null +++ b/styles/examples/strong.style @@ -0,0 +1,5 @@ +{ + "strong": { + "bold": true + } +} diff --git a/styles/examples/table.md b/styles/examples/table.md new file mode 100644 index 0000000..a752b0c --- /dev/null +++ b/styles/examples/table.md @@ -0,0 +1,4 @@ +| Label | Value | +| ------ | ----- | +| First | foo | +| Second | bar | diff --git a/styles/examples/table.png b/styles/examples/table.png new file mode 100644 index 0000000..69ebbc3 Binary files /dev/null and b/styles/examples/table.png differ diff --git a/styles/examples/table.style b/styles/examples/table.style new file mode 100644 index 0000000..1b2d9b6 --- /dev/null +++ b/styles/examples/table.style @@ -0,0 +1,5 @@ +{ + "table": { + "margin": 4 + } +} diff --git a/styles/examples/text.style b/styles/examples/text.style new file mode 100644 index 0000000..8c1bb42 --- /dev/null +++ b/styles/examples/text.style @@ -0,0 +1,7 @@ +{ + "text": { + "bold": true, + "color": "15", + "background_color": "57" + } +}