ssg
ssg is a tiny static site generator that can render HTML templates based on
JSON data files.
Installation
git clone https://git.sr.ht/~eugenetriguba/ssg
cd ssg
make install
If you want to uninstall later:
make uninstall
Quick Start
ssg init mysite
cd mysite
ssg build
ssg serve
Open http://localhost:8080 to view your site.
Directory Structure
mysite/
├── data/ # JSON data files (become html template variables)
├── templates/ # HTML templates (rendered to output directory)
├── static/ # Static files (copied unchanged to output directory)
└── dist/ # Output directory (default)
Commands
| Command | Description |
|---|---|
ssg init [dir] |
Create a new site |
ssg build |
Build the site |
ssg serve |
Start local HTTP server |
ssg version |
Print version |
ssg help [cmd] |
Show man pages |
Templates
Templates use Go’s html/template syntax. JSON files in data/ become
template variables named after the file (minus .json).
data/projects.json:
json
[
{"name": "foo", "url": "https://example.com/foo"},
{"name": "bar", "url": "https://example.com/bar"}
]
templates/index.html:
html
<ul>
{{range .projects}}
<li><a href="{{.url}}">{{.name}}</a></li>
{{end}}
</ul>
Documentation
See ssg help or man ssg for full documentation.