From 4993f633f179c348d8013b5c35fb8f602d079ccb Mon Sep 17 00:00:00 2001 From: Dave Henderson Date: Sun, 11 Feb 2018 10:09:53 -0500 Subject: new logo Signed-off-by: Dave Henderson --- Makefile | 5 ++ README.md | 8 +- docs/config.toml | 7 +- docs/content/_index.md | 25 ++++++ docs/content/index.md | 32 ------- docs/content/installing.md | 1 - docs/content/usage.md | 10 +-- docs/layouts/shortcodes/year.html | 1 + docs/static/favicon.ico | Bin 0 -> 34494 bytes docs/static/images/gomplate-icon.png | Bin 0 -> 17526 bytes docs/static/images/gomplate-icon.svg | 25 ++++++ docs/static/images/gomplate.png | Bin 0 -> 44740 bytes docs/static/images/gomplate.svg | 32 +++++++ docs/static/stylesheets/custom-palettes.css | 126 ++++++++++++++++++++++++++++ 14 files changed, 228 insertions(+), 44 deletions(-) create mode 100644 docs/content/_index.md delete mode 100644 docs/content/index.md create mode 100644 docs/layouts/shortcodes/year.html create mode 100644 docs/static/favicon.ico create mode 100644 docs/static/images/gomplate-icon.png create mode 100644 docs/static/images/gomplate-icon.svg create mode 100644 docs/static/images/gomplate.png create mode 100644 docs/static/images/gomplate.svg create mode 100644 docs/static/stylesheets/custom-palettes.css diff --git a/Makefile b/Makefile index 105c6bcf..cb48ee61 100644 --- a/Makefile +++ b/Makefile @@ -115,6 +115,11 @@ docs/themes/hugo-material-docs: gen-docs: docs/themes/hugo-material-docs cd docs/; hugo +# this target doesn't usually get used - it's mostly here as a reminder to myself +# hint: make sure CLOUDCONVERT_API_KEY is set ;) +gomplate.png: gomplate.svg + cloudconvert -f png -c density=288 $^ + ifeq ("$(CI)","true") lint: gometalinter -j 1 --vendor --deadline 120s --disable gotype --enable gofmt --enable goimports --enable misspell --enable unused --disable gas diff --git a/README.md b/README.md index 64c5bfca..cea1731e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +gomplate logo + +_Read the docs at [gomplate.hairyhenderson.ca][docs-url]._ + [![Build Status][circleci-image]][circleci-url] [![Windows Build][appveyor-image]][appveyor-url] [![Go Report Card][reportcard-image]][reportcard-url] @@ -15,10 +19,6 @@ [![Install Docs][install-docs-image]][install-docs-url] -_Read the docs at [gomplate.hairyhenderson.ca][docs-url]._ - -# gomplate - A [Go template](https://golang.org/pkg/text/template/)-based CLI tool. `gomplate` can be used as an alternative to [`envsubst`](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) but also supports additional template datasources such as: JSON, YAML, AWS EC2 metadata, [BoltDB](https://github.com/boltdb/bolt), diff --git a/docs/config.toml b/docs/config.toml index 3277cc09..ee896149 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -1,7 +1,6 @@ baseURL = "/" languageCode = "en-us" title = "gomplate documentation" - theme = "hugo-material-docs" [params] @@ -11,9 +10,13 @@ theme = "hugo-material-docs" provider = "GitHub" repo_url = "https://github.com/hairyhenderson/gomplate" googleAnalytics = "UA-82637990-1" + logo = "images/gomplate-icon.svg" + favicon = "favicon.ico" + custom_css = ["stylesheets/custom-palettes.css"] [params.palette] - primary = "indigo" + primary = "spalding-gray" + accent = "spalding-blue" [social] twitter = "hairyhenderson" diff --git a/docs/content/_index.md b/docs/content/_index.md new file mode 100644 index 00000000..117dd05d --- /dev/null +++ b/docs/content/_index.md @@ -0,0 +1,25 @@ +--- +title: gomplate +type: index +weight: 1 +menu: + main: + name: About +--- + +A [Go template](https://golang.org/pkg/text/template/)-based CLI tool. `gomplate` can be used as an alternative to +[`envsubst`](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) but also supports +additional template datasources such as: JSON, YAML, AWS EC2 metadata, [BoltDB](https://github.com/boltdb/bolt), +[Hashicorp Consul](https://www.consul.io/) and [Hashicorp Vault](https://www.vaultproject.io/) secrets. + +I really like `envsubst` for use as a super-minimalist template processor. But its simplicity is also its biggest flaw: it's all-or-nothing with shell-like variables. + +Gomplate is an alternative that will let you process templates which also include shell-like variables. Also there are some useful built-in functions that can be used to make templates even more expressive. + + +_Please report any bugs found in the [issue tracker](https://github.com/hairyhenderson/gomplate/issues/)._ +## License + +[The MIT License](http://opensource.org/licenses/MIT) + +Copyright (c) 2016-{{< year >}} Dave Henderson diff --git a/docs/content/index.md b/docs/content/index.md deleted file mode 100644 index dc8c62a9..00000000 --- a/docs/content/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: gomplate -type: index -weight: 1 -menu: - main: - name: About ---- - -A [Go template](https://golang.org/pkg/text/template/)-based CLI tool. `gomplate` can be used as an alternative to -[`envsubst`](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) but also supports -additional template datasources such as: JSON, YAML, AWS EC2 metadata, [BoltDB](https://github.com/boltdb/bolt), -[Hashicorp Consul](https://www.consul.io/) and [Hashicorp Vault](https://www.vaultproject.io/) secrets. - -I really like `envsubst` for use as a super-minimalist template processor. But its simplicity is also its biggest flaw: it's all-or-nothing with shell-like variables. - -Gomplate is an alternative that will let you process templates which also include shell-like variables. Also there are some useful built-in functions that can be used to make templates even more expressive. - - -_Please report any bugs found in the [issue tracker](https://github.com/hairyhenderson/gomplate/issues/)._ - -{{< note title="Note" >}} -This documentation is still in the process of being migrated out of the -[README](https://github.com/hairyhenderson/gomplate/tree/master/README.md), so -expect some inconsistencies! If you want to help, [PRs and issues are welcome!](https://github.com/hairyhenderson/gomplate/issues/new) -{{< /note >}} - -## License - -[The MIT License](http://opensource.org/licenses/MIT) - -Copyright (c) 2016-2017 Dave Henderson diff --git a/docs/content/installing.md b/docs/content/installing.md index ba566681..55d92aa8 100644 --- a/docs/content/installing.md +++ b/docs/content/installing.md @@ -3,7 +3,6 @@ title: Installing weight: 10 menu: main --- -# Installing ## macOS with homebrew diff --git a/docs/content/usage.md b/docs/content/usage.md index 341877fb..de4ec93b 100644 --- a/docs/content/usage.md +++ b/docs/content/usage.md @@ -17,9 +17,9 @@ $ echo "Hello, {{.Env.USER}}" | gomplate Hello, hairyhenderson ``` -# Commandline Arguments +## Commandline Arguments -## `--file`/`-f`, `--in`/`-i`, and `--out`/`-o` +### `--file`/`-f`, `--in`/`-i`, and `--out`/`-o` By default, `gomplate` will read from `Stdin` and write to `Stdout`. This behaviour can be changed. @@ -27,7 +27,7 @@ By default, `gomplate` will read from `Stdin` and write to `Stdout`. This behavi - Use `--out`/`-o` to save output to file. The special value `-` means `Stdout`. - Use `--in`/`-i` if you want to set the input template right on the commandline. This overrides `--file`. Because of shell command line lengths, it's probably not a good idea to use a very long value with this argument. -### Multiple inputs +#### Multiple inputs You can specify multiple `--file` and `--out` arguments. The same number of each much be given. This allows `gomplate` to process multiple templates _slightly_ faster than invoking `gomplate` multiple times in a row. @@ -58,7 +58,7 @@ This will stop all files in the example folder from being processed, as well as You can also chain the exclude flag to build up a series of globs to be excluded -## `--datasource`/`-d` +### `--datasource`/`-d` Add a data source in `name=URL` form. Specify multiple times to add multiple sources. The data can then be used by the [`datasource`](../functions/#datasource) and [`include`](../functions/#include) functions. @@ -70,7 +70,7 @@ A few different forms are valid: - `mydata.json` - This form infers the name from the file name (without extension). Only valid for files in the current directory. -## Overriding the template delimiters +### Overriding the template delimiters Sometimes it's necessary to override the default template delimiters (`{{`/`}}`). Use `--left-delim`/`--right-delim` or set `$GOMPLATE_LEFT_DELIM`/`$GOMPLATE_RIGHT_DELIM`. diff --git a/docs/layouts/shortcodes/year.html b/docs/layouts/shortcodes/year.html new file mode 100644 index 00000000..e7980c9a --- /dev/null +++ b/docs/layouts/shortcodes/year.html @@ -0,0 +1 @@ +{{ now.Year }} diff --git a/docs/static/favicon.ico b/docs/static/favicon.ico new file mode 100644 index 00000000..2ad930c3 Binary files /dev/null and b/docs/static/favicon.ico differ diff --git a/docs/static/images/gomplate-icon.png b/docs/static/images/gomplate-icon.png new file mode 100644 index 00000000..60218354 Binary files /dev/null and b/docs/static/images/gomplate-icon.png differ diff --git a/docs/static/images/gomplate-icon.svg b/docs/static/images/gomplate-icon.svg new file mode 100644 index 00000000..3c8a9d44 --- /dev/null +++ b/docs/static/images/gomplate-icon.svg @@ -0,0 +1,25 @@ + + + + + + + }} + diff --git a/docs/static/images/gomplate.png b/docs/static/images/gomplate.png new file mode 100644 index 00000000..de957392 Binary files /dev/null and b/docs/static/images/gomplate.png differ diff --git a/docs/static/images/gomplate.svg b/docs/static/images/gomplate.svg new file mode 100644 index 00000000..e982ad7f --- /dev/null +++ b/docs/static/images/gomplate.svg @@ -0,0 +1,32 @@ + + + + + + + + }} + diff --git a/docs/static/stylesheets/custom-palettes.css b/docs/static/stylesheets/custom-palettes.css new file mode 100644 index 00000000..ad7e2a2f --- /dev/null +++ b/docs/static/stylesheets/custom-palettes.css @@ -0,0 +1,126 @@ +@import url('https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,300,400'); + +@supports (-webkit-appearance:none) { + .palette-primary-spalding-gray { + background: rgb(145, 132, 121) + } +} + +.palette-primary-spalding-gray .footer, +.palette-primary-spalding-gray .header { + background: rgb(145, 132, 121) +} + +.palette-primary-spalding-gray .drawer .toc a.current, +.palette-primary-spalding-gray .drawer .toc a:focus, +.palette-primary-spalding-gray .drawer .toc a:hover { + color: rgb(145, 132, 121) +} + +.palette-primary-spalding-gray .drawer .anchor a { + border-left: 2px solid rgb(145, 132, 121); +} + +.ios.standalone .palette-primary-spalding-gray .article { + background: -webkit-linear-gradient(top, #fff 50%, rgb(145, 132, 121) 0); + background: linear-gradient(180deg, #fff 50%, rgb(145, 132, 121) 0); +} + +.palette-primary-spalding-gray .article a, +.palette-primary-spalding-gray .article code, +.palette-primary-spalding-gray .article h1, +.palette-primary-spalding-gray .article h2 { + color: rgb(145, 132, 121) +} + +.palette-primary-spalding-gray .article .headerlink { + color: rgba(0, 0, 0, .26) +} + +.palette-primary-spalding-gray .article table th { + background: #6d6259; +} + +.palette-primary-spalding-gray .results .meta { + background: rgb(145, 132, 121) +} + +.palette-accent-spalding-gray .article a:focus, +.palette-accent-spalding-gray .article a:hover { + color: #bb8550; +} + +.palette-accent-spalding-gray .repo a { + background: #bb8550; +} + +@media only screen and (max-width:959px) { + .palette-primary-spalding-gray .project { + background: rgb(145, 132, 121) + } +} + +@supports (-webkit-appearance:none) { + .palette-primary-spalding-blue { + background: rgb(120, 133, 145); + } +} + +.palette-primary-spalding-blue .footer, +.palette-primary-spalding-blue .header { + background: rgb(120, 133, 145); +} + +.palette-primary-spalding-blue .drawer .toc a.current, +.palette-primary-spalding-blue .drawer .toc a:focus, +.palette-primary-spalding-blue .drawer .toc a:hover { + color: rgb(120, 133, 145); +} + +.palette-primary-spalding-blue .drawer .anchor a { + border-left: 2px solid rgb(120, 133, 145); +} + +.ios.standalone .palette-primary-spalding-blue .article { + background: -webkit-linear-gradient(top, #fff 50%, rgb(120, 133, 145) 0); + background: linear-gradient(180deg, #fff 50%, rgb(120, 133, 145) 0); +} + +.palette-primary-spalding-blue .article a, +.palette-primary-spalding-blue .article code, +.palette-primary-spalding-blue .article h1, +.palette-primary-spalding-blue .article h2 { + color: rgb(120, 133, 145); +} + +.palette-primary-spalding-blue .article .headerlink { + color: rgba(0, 0, 0, .26) +} + +.palette-primary-spalding-blue .article table th { + background: #596d63; +} + +.palette-primary-spalding-blue .results .meta { + background: rgb(120, 133, 145); +} + +.palette-accent-spalding-blue .article a:focus, +.palette-accent-spalding-blue .article a:hover { + color: #787991; +} + +.palette-accent-spalding-blue .repo a { + background: #596d63; +} + +@media only screen and (max-width:959px) { + .palette-primary-spalding-blue .project { + background: rgb(120, 133, 145); + } +} + +header .title { + font-family: 'Source Sans Pro', 'Roboto', Helvetica, Arial, sans-serif; + font-weight: 300; +} -- cgit v1.2.3