alex/goldsmith
1
Fork 0
Code Releases Activity

Update README

Browse Source
This commit is contained in:
Alex Yatskov 2021-06-08 20:53:41 -07:00
parent ec13a459ec
commit 5ba198d6d8
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,10 +1,10 @@
# Goldsmith # # Goldsmith
Goldsmith is a fast and easily extensible static website generator written in Go. In contrast to many other generators, 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 Goldsmith does not force any design paradigms or file organization rules on the user, making it possible to generate
anything from blogs to image galleries using the same tool. anything from blogs to image galleries using the same tool.
## Tutorial ## ## Tutorial
Goldsmith does not use any configuration files, and all behavior customization happens in code. Goldsmith uses the 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 [builder pattern](https://en.wikipedia.org/wiki/Builder_pattern) to establish a chain, which modifies files as they pass
@ -135,7 +135,7 @@ understand, it is often best to learn by example:
} }
``` ```
## Samples ## ## Samples
Below are some examples of Goldsmith usage which can used to base your site on: Below are some examples of Goldsmith usage which can used to base your site on:
@ -146,11 +146,11 @@ Below are some examples of Goldsmith usage which can used to base your site on:
* [FooSoft.net](https://foosoft.net/projects/goldsmith): I've been "dogfooding" Goldsmith by using it to build * [FooSoft.net](https://foosoft.net/projects/goldsmith): I've been "dogfooding" Goldsmith by using it to build
my homepage for years. my homepage for years.
## Components ## ## Components
A growing set of plugins, filters, and other tools are provided to make it easier to get started with Goldsmith. A growing set of plugins, filters, and other tools are provided to make it easier to get started with Goldsmith.
### Plugins ### ### Plugins
* [Absolute](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/absolute): Convert relative HTML file * [Absolute](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/absolute): Convert relative HTML file
references to absolute paths. references to absolute paths.
@ -183,7 +183,7 @@ A growing set of plugins, filters, and other tools are provided to make it easie
* [Thumbnail](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/thumbnail): Build thumbnails for a * [Thumbnail](https://godoc.org/github.com/FooSoft/goldsmith-components/plugins/thumbnail): Build thumbnails for a
variety of common image formats. variety of common image formats.
### Filters ### ### Filters
* [Condition](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/condition): Filter files based on a * [Condition](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/condition): Filter files based on a
single condition. single condition.
@ -192,7 +192,7 @@ A growing set of plugins, filters, and other tools are provided to make it easie
* [Wildcard](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/wildcard): Filter files using path * [Wildcard](https://godoc.org/github.com/FooSoft/goldsmith-components/filters/wildcard): Filter files using path
wildcards (`*`, `?`, etc.) wildcards (`*`, `?`, etc.)
### Other ### ### Other
* [DevServer](https://godoc.org/github.com/FooSoft/goldsmith-components/devserver): Simple framework for building, * [DevServer](https://godoc.org/github.com/FooSoft/goldsmith-components/devserver): Simple framework for building,
updating, and viewing your site. updating, and viewing your site.