Skip to content

Commit

Permalink
new logo
Browse files Browse the repository at this point in the history
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
  • Loading branch information
hairyhenderson committed Feb 12, 2018
1 parent 16810fd commit 72232a6
Show file tree
Hide file tree
Showing 13 changed files with 202 additions and 18 deletions.
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

[![Install Docs][install-docs-image]][install-docs-url]

_Read the docs at [gomplate.hairyhenderson.ca][docs-url]._
<img src="docs/static/images/gomplate.png" width="512px" alt="gomplate logo"/>

# gomplate
_Read the docs at [gomplate.hairyhenderson.ca][docs-url]._

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
Expand Down
7 changes: 5 additions & 2 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
baseURL = "/"
languageCode = "en-us"
title = "gomplate documentation"

theme = "hugo-material-docs"

[params]
Expand All @@ -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"
Expand Down
9 changes: 1 addition & 8 deletions docs/content/index.md → docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,8 @@ Gomplate is an alternative that will let you process templates which also includ


_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
Copyright (c) 2016-{{< year >}} Dave Henderson
1 change: 0 additions & 1 deletion docs/content/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Installing
weight: 10
menu: main
---
# Installing

## macOS with homebrew

Expand Down
10 changes: 5 additions & 5 deletions docs/content/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ $ 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.

- Use `--file`/`-f` to use a specific input template file. The special value `-` means `Stdin`.
- 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.

Expand Down Expand Up @@ -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.

Expand All @@ -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`.
1 change: 1 addition & 0 deletions docs/layouts/shortcodes/year.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ now.Year }}
Binary file added docs/static/favicon.ico
Binary file not shown.
Binary file added docs/static/images/gomplate-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/static/images/gomplate-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/gomplate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/static/images/gomplate.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
126 changes: 126 additions & 0 deletions docs/static/stylesheets/custom-palettes.css
Original file line number Diff line number Diff line change
@@ -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;
}

0 comments on commit 72232a6

Please sign in to comment.