README
¶
blog
A static site generator built in Go.
Prerequisites
- Go 1.25+
- Task
- browser-sync (optional, for
devlive reload)
Development
# Install needed tools
task setup
# Validate the Go generator
task validate
# Generate and validate the site
task generate
# Generate the site and serve it locally
task serve &
task dev
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
abspath
Package abspath resolves references found in generated HTML to paths in the build output.
|
Package abspath resolves references found in generated HTML to paths in the build output. |
|
backbone/section
Package section resolves the top-level site sections that a piece of content belongs to.
|
Package section resolves the top-level site sections that a piece of content belongs to. |
|
generator/page/html/validation/access
Package access checks whether external references found in generated HTML are reachable.
|
Package access checks whether external references found in generated HTML are reachable. |
|
generator/page/html/validation/htmlref
Package htmlref locates and classifies the references (the values of src and href attributes) found in generated HTML.
|
Package htmlref locates and classifies the references (the values of src and href attributes) found in generated HTML. |
|
generator/page/html/validation/jssyntax
Package jssyntax validates the syntax of local JavaScript files referenced by generated HTML.
|
Package jssyntax validates the syntax of local JavaScript files referenced by generated HTML. |
|
generator/page/html/validation/reference
Package reference validates the references (images, links, scripts) embedded in generated HTML.
|
Package reference validates the references (images, links, scripts) embedded in generated HTML. |
|
hrefpath
Package hrefpath computes the absolute, root-relative URL used to link to a generated page from anywhere else on the site, given only the page's source markdown path.
|
Package hrefpath computes the absolute, root-relative URL used to link to a generated page from anywhere else on the site, given only the page's source markdown path. |
|
io/fs
Package fs provides utilities for searching files and copying directories within a filesystem using the afero.Fs abstraction.
|
Package fs provides utilities for searching files and copying directories within a filesystem using the afero.Fs abstraction. |
|
relpath
Package relpath provides utilities for resolving relative file paths between different locations within a project, primarily used for generating correct links, assets, and page paths in HTML output.
|
Package relpath provides utilities for resolving relative file paths between different locations within a project, primarily used for generating correct links, assets, and page paths in HTML output. |
Click to show internal directories.
Click to hide internal directories.