goldsmith/README.md

201 lines
9.9 KiB
Markdown
Raw Normal View History

2016-09-07 04:15:59 +00:00
# Goldsmith #
2016-01-12 10:24:19 +00:00
2019-04-08 23:17:12 +00:00
Goldsmith is a fast and easily extensible static website generator written in Go. In contrast to many other generators,
Goldsmith does not force any design paradigms or file organization rules on the user, making it possible to generate
2019-04-08 19:02:18 +00:00
anything from blogs to image galleries using the same tool.
2016-01-12 10:24:19 +00:00
2019-04-08 19:02:18 +00:00
## Tutorial ##
2016-09-07 04:50:46 +00:00
2019-04-08 23:17:12 +00:00
Goldsmith does not use any configuration files, and all behavior customization happens in code. Goldsmith uses the
[builder pattern](https://en.wikipedia.org/wiki/Builder_pattern) to establish a chain, which modifies files as they pass
through it. Although the [Goldsmith](https://godoc.org/github.com/FooSoft/goldsmith) is short and (hopefully) easy to
understand, it is often best to learn by example:
2016-07-12 03:52:43 +00:00
2019-04-09 00:50:19 +00:00
1. Start by copying files from a source directory to a destination directory (the simplest possible use case):
2018-02-22 03:14:55 +00:00
2019-04-08 19:02:18 +00:00
```go
goldsmith.
Begin(srcDir). // read files from srcDir
End(dstDir) // write files to dstDir
```
2016-01-12 10:24:19 +00:00
2019-04-09 00:50:19 +00:00
2. Now let's convert any Markdown files to HTML fragments (while still copying the rest), using the
2019-04-08 19:02:18 +00:00
[Markdown](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/markdown) plugin:
2016-09-07 04:13:37 +00:00
2017-09-30 00:03:53 +00:00
```go
2019-04-08 19:02:18 +00:00
goldsmith.
Begin(srcDir). // read files from srcDir
Chain(markdown.New()). // convert *.md files to *.html files
End(dstDir) // write files to dstDir
2016-01-12 10:24:19 +00:00
```
2019-04-09 00:50:19 +00:00
3. If we have any
2019-04-08 23:17:12 +00:00
[front matter](https://raw.githubusercontent.com/FooSoft/goldsmith-samples/master/basic/content/index.md) in our
Markdown files, we need to extract it using the,
[FrontMatter](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/frontmatter) plugin:
2016-09-07 04:13:37 +00:00
2017-09-30 00:03:53 +00:00
```go
2019-04-08 19:02:18 +00:00
goldsmith.
Begin(srcDir). // read files from srcDir
Chain(frontmatter.New()). // extract frontmatter and store it as metadata
Chain(markdown.New()). // convert *.md files to *.html files
End(dstDir) // write files to dstDir
2016-01-12 10:24:19 +00:00
```
2019-04-09 00:50:19 +00:00
4. Next, we should run our barebones HTML through a
2019-04-08 19:02:18 +00:00
[template](https://raw.githubusercontent.com/FooSoft/goldsmith-samples/master/basic/content/layouts/basic.gohtml) to
2019-04-08 23:17:12 +00:00
add elements like a header, footer, or a menu; for this we can use the
2019-04-08 19:02:18 +00:00
[Layout](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/frontmatter) plugin:
2016-09-07 04:13:37 +00:00
2017-09-30 00:03:53 +00:00
```go
2019-04-08 19:02:18 +00:00
goldsmith.
Begin(srcDir). // read files from srcDir
Chain(frontmatter.New()). // extract frontmatter and store it as metadata
Chain(markdown.New()). // convert *.md files to *.html files
Chain(layout.New()). // apply *.gohtml templates to *.html files
End(dstDir) // write files to dstDir
2016-01-12 10:24:19 +00:00
```
2019-04-09 00:50:19 +00:00
5. Now, let's [minify](https://en.wikipedia.org/wiki/Minification_(programming)) our files to reduce data transfer and
2019-04-08 23:17:12 +00:00
load times for our site's visitors using the
2019-04-08 19:02:18 +00:00
[Minify](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/minify) plugin:
2016-09-07 04:13:37 +00:00
2017-09-30 00:03:53 +00:00
```go
2019-04-08 19:02:18 +00:00
goldsmith.
Begin(srcDir). // read files from srcDir
Chain(frontmatter.New()). // extract frontmatter and store it as metadata
Chain(markdown.New()). // convert *.md files to *.html files
Chain(layout.New()). // apply *.gohtml templates to *.html files
Chain(minify.New()). // minify *.html, *.css, *.js, etc. files
End(dstDir) // write files to dstDir
2016-01-12 10:24:19 +00:00
```
2019-04-09 00:50:19 +00:00
6. Debugging problems in minified code can be tricky, so let's use the
2019-04-08 23:17:12 +00:00
[Condition](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/condition) filter to make minification
occur only when we are ready for distribution.
2016-09-07 04:13:37 +00:00
2017-09-30 00:03:53 +00:00
```go
2019-04-08 19:02:18 +00:00
goldsmith.
Begin(srcDir). // read files from srcDir
Chain(frontmatter.New()). // extract frontmatter and store it as metadata
Chain(markdown.New()). // convert *.md files to *.html files
Chain(layout.New()). // apply *.gohtml templates to *.html files
FilterPush(condition.New(dist)). // push a dist-only conditional filter onto the stack
Chain(minify.New()). // minify *.html, *.css, *.js, etc. files
FilterPop(). // pop off the last filter pushed onto the stack
End(dstDir) // write files to dstDir
2016-01-12 10:24:19 +00:00
```
2019-04-09 00:50:19 +00:00
7. Now that we have all of our plugins chained up, let's look at a complete example which uses
2019-04-08 19:02:18 +00:00
[DevServer](https://godoc.org/github.com/FooSoft/goldsmith-components/devserver) to bootstrap a complete development
sever which automatically rebuilds the site whenever source files are updated.
2016-09-07 04:13:37 +00:00
2017-09-30 00:03:53 +00:00
```go
2016-09-07 04:13:37 +00:00
package main
import (
2019-04-08 19:02:18 +00:00
"flag"
2016-09-07 04:13:37 +00:00
"log"
"github.com/FooSoft/goldsmith"
2019-04-08 19:02:18 +00:00
"github.com/FooSoft/goldsmith-components/devserver"
"github.com/FooSoft/goldsmith-components/filters/condition"
"github.com/FooSoft/goldsmith-components/plugins/frontmatter"
"github.com/FooSoft/goldsmith-components/plugins/layout"
"github.com/FooSoft/goldsmith-components/plugins/markdown"
"github.com/FooSoft/goldsmith-components/plugins/minify"
2016-09-07 04:13:37 +00:00
)
2019-04-08 19:02:18 +00:00
type builder struct {
dist bool
}
2016-09-07 04:13:37 +00:00
2019-04-08 19:02:18 +00:00
func (b *builder) Build(srcDir, dstDir, cacheDir string) {
errs := goldsmith.
Begin(srcDir). // read files from srcDir
Chain(frontmatter.New()). // extract frontmatter and store it as metadata
Chain(markdown.New()). // convert *.md files to *.html files
Chain(layout.New()). // apply *.gohtml templates to *.html files
FilterPush(condition.New(b.dist)). // push a dist-only conditional filter onto the stack
Chain(minify.New()). // minify *.html, *.css, *.js, etc. files
FilterPop(). // pop off the last filter pushed onto the stack
End(dstDir) // write files to dstDir
2016-09-07 04:13:37 +00:00
for _, err := range errs {
log.Print(err)
}
}
func main() {
2019-04-08 19:02:18 +00:00
port := flag.Int("port", 8080, "server port")
dist := flag.Bool("dist", false, "final dist mode")
flag.Parse()
devserver.DevServe(&builder{*dist}, *port, "content", "build", "cache")
2016-09-07 04:13:37 +00:00
}
```
2019-04-08 19:02:18 +00:00
## Samples ##
Below are some examples of Goldsmith usage which can used to base your site on:
* [Basic Sample](https://github.com/FooSoft/goldsmith-samples/tree/master/basic): a great starting point, this is the
sample site from the tutorial.
* [Bootstrap Sample](https://github.com/FooSoft/goldsmith-samples/tree/master/bootstrap): a slightly more advanced
sample using [Bootstrap](https://getbootstrap.com/).
2019-04-09 02:29:40 +00:00
* [FooSoft.net](https://foosoft.net/projects/goldsmith): I've been "dogfooding" Goldsmith by using it to build
my homepage for years.
2019-04-08 19:02:18 +00:00
## Components ##
A growing set of plugins, filters, and other tools are provided to make it easier to get started with Goldsmith.
### Plugins ###
* [Absolute](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/absolute): Convert relative HTML file
references to absolute paths.
* [Breadcrumbs](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/breadcrumbs): Generate metadata
2019-04-08 23:17:12 +00:00
required to build breadcrumb navigation.
2019-04-08 19:02:18 +00:00
* [Collection](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/collection): Group related pages
2019-04-09 00:50:19 +00:00
into named collections.
2019-04-08 19:02:18 +00:00
* [Document](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/document): Enable simple DOM
modification via an API similar to jQuery.
2019-04-08 23:17:12 +00:00
* [FrontMatter](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/frontmatter): Extract the
JSON, YAML, or TOML metadata stored in your files.
* [Index](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/index): Create metadata for directory file
2019-04-08 19:02:18 +00:00
listings and generate directory index pages.
2019-04-08 23:17:12 +00:00
* [Layout](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/layout): Transform your HTML files with
Go templates.
* [LiveJs](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/livejs): Inject JavaScript code to
automatically reload pages when modified.
2019-04-08 19:02:18 +00:00
* [Markdown](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/markdown): Render Markdown documents
2019-04-08 23:17:12 +00:00
as HTML fragments.
2019-04-08 19:02:18 +00:00
* [Minify](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/minify): Remove superfluous data from a
variety of web formats.
* [Pager](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/pager): Split arrays of metadata into
standalone pages.
2019-04-08 23:17:12 +00:00
* [Summary](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/summary): Extract summary and title
metadata from HTML files.
* [Syntax](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/syntax): Enable syntax highlighting for
pre-formatted code blocks.
2019-04-09 00:50:19 +00:00
* [Tags](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/tags): Generate tag clouds and indices
2019-04-08 23:17:12 +00:00
from file metadata.
* [Thumbnail](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/thumbnail): Build thumbnails for a
2019-04-08 19:02:18 +00:00
variety of common image formats.
### Filters ###
* [Condition](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/condition): Filter files based on a
single condition.
* [Operator](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/operator): Join filters using
logical `AND`, `OR`, and `NOT` operators.
* [Wildcard](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/wildcard): Filter files using path
wildcards (`*`, `?`, etc.)
### Other ###
2016-01-12 10:24:19 +00:00
2019-04-08 23:17:12 +00:00
* [DevServer](https://godoc.org/github.com/FooSoft/goldsmith-components/devserver): Simple framework for building,
updating, and viewing your site.
* [Harness](https://godoc.org/github.com/FooSoft/goldsmith-components/harness): Unit test harness for verifying
Goldsmith plugins and filters.