README
¶
gen
Installing
Run go get github.com/jwowillo/gen to install the package.
Documentation
Documentation is located in directory 'doc' in the form of Markdown-files for the project requirements and design. PDFs generated from these are also included. API documentation is located at https://godoc.org/github.com/jwowillo/gen.
Documentation
¶
Overview ¶
Package gen allows page.Pages to be transformed and written to a directory to generate a website.
Some transformer.Transformers and page.Pages are provided.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Write ¶
func Write(out string, ps []page.Page, ts ...transformer.Transformer) []error
Write the page.Pages to the directory after applying the transformer.Transformers in order.
Returns an error if any of the transformer.Transformers couldn't by applied or any page.Pages couldn't be written.
func WriteWithDefaults ¶
WriteWithDefaults writes the page.Pages to the out directory after applying the transformer.Bundle, transformer.Minify, and transformer.Gzip transforms.
Returns an error if any transformer.Transformers couldn't be applied or any page.Pages couldn't be written.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gen_server
Package main has a file server that exposes a directory and listens on a port that are passed in flags.
|
Package main has a file server that exposes a directory and listens on a port that are passed in flags. |
|
internal
|
|
|
page.page/pipe.v1
Package pipe allows Stages of functions to easily be assembled into concurent pipes.
|
Package pipe allows Stages of functions to easily be assembled into concurent pipes. |
|
Package server has a constructor for a http.Handler which serves static files from a directory and properly sets or doesn't set the Gzip header for each file.
|
Package server has a constructor for a http.Handler which serves static files from a directory and properly sets or doesn't set the Gzip header for each file. |