Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tj/staticgen
Static website generator that lets you use HTTP servers and frameworks you already know
https://github.com/tj/staticgen
static static-site static-site-generator
Last synced: 13 days ago
JSON representation
Static website generator that lets you use HTTP servers and frameworks you already know
- Host: GitHub
- URL: https://github.com/tj/staticgen
- Owner: tj
- License: mit
- Created: 2019-10-04T13:26:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T17:06:14.000Z (almost 2 years ago)
- Last Synced: 2024-10-16T21:24:37.886Z (26 days ago)
- Topics: static, static-site, static-site-generator
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 721
- Watchers: 7
- Forks: 13
- Open Issues: 14
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list - staticgen
- jimsghstars - tj/staticgen - Static website generator that lets you use HTTP servers and frameworks you already know (Go)
README
# Staticgen
A static website generator that lets you use HTTP servers and frameworks you already know. Just tell Staticgen how to start your server, then watch it crawl your site and generate a static version with all of the pages and assets required.
## About
If you're unfamiliar, you can actually use the decades-old [wget command](https://apex.sh/blog/post/pre-render-wget/) to output a static website from a dynamic one, this project is purpose-built for the same idea, letting your team to use whatever HTTP servers and frameworks you're already familiar with, in any language.
I haven't done any scientific benchmarks or comparisons yet, but here are some results on my 2014 8-core MBP:
- Compiles 3,296 pages of the [Signal v. Noise](https://m.signalvnoise.com/) blog in 1 second
- Compiles my [Apex Software](https://apex.sh/) site in 150ms
## Installation
Via [gobinaries.com](https://gobinaries.com):
```sh
$ curl -sf https://gobinaries.com/tj/staticgen/cmd/staticgen | sh
```
## Configuration
Configuration is stored within a `./static.json` file in your project's root directory. The following options are available:
- __command__ — The server command executed before crawling.
- __url__ — The target website to crawl. Defaults to `"http://127.0.0.1:3000"`.
- __dir__ — The static website output directory. Defaults to `"build"`.
- __pages__ — A list of paths added to crawl, typically including unlinked pages such as landing pages. Defaults to `[]`.
- __concurrency__ — The number of concurrent pages to crawl. Defaults to `30`.
## Guide
First create the `./static.json` configuration file, for example here's the config for Go server, the only required property is `command`:
```json
{
"command": "go run main.go",
"concurrency": 50,
"dir": "dist"
}
```
Below is an example of a Node.js server, note that `NODE_ENV` is assigned to production so that optimizations such as Express template caches are used to improve serving performance.
```json
{
"command": "NODE_ENV=production node server.js"
}
```
Run the `staticgen` command to start the pre-rendering process:
```
$ staticgen
```
Staticgen executes the `command` you provided, waits for the server to become available on the `url` configured. The pages and assets are copied to the `dir` configured and then your server is shut down.
By default the timeout for the generation process is 15 minutes, depending on your situation you may want to increase or decrease this with the `-t, --timeout` flag, here are some examples:
```
$ staticgen -t 30s
$ staticgen -t 15m
$ staticgen -t 1h
```
When launching the `command`, Staticgen sets the `STATICGEN` environment variable to `1`, allowing you to alter behaviour if necessary.
To view the pre-rendered site run the following command to start a static file server and open the browser:
```
$ staticgen serve
```
See the [examples](./_examples) directory for full examples.
## Notes
Staticgen does not pre-render using a headless browser, this makes it faster, however it means that you cannot rely on client-side JavaScript manipulating the page.
---
[](https://godoc.org/github.com/tj/staticgen)
## Sponsors
This project is sponsored by [CTO.ai](https://cto.ai/), making it easy for development teams to create and share workflow automations without leaving the command line.
[](https://cto.ai/)
And my [GitHub sponsors](https://github.com/sponsors/tj):
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/0)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/1)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/2)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/3)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/4)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/5)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/6)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/7)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/8)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/9)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/10)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/11)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/12)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/13)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/14)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/15)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/16)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/17)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/18)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/19)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/20)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/21)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/22)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/23)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/24)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/25)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/26)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/27)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/28)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/29)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/30)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/31)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/32)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/33)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/34)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/35)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/36)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/37)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/38)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/39)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/40)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/41)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/42)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/43)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/44)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/45)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/46)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/47)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/48)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/49)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/50)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/51)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/52)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/53)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/54)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/55)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/56)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/57)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/58)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/59)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/60)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/61)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/62)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/63)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/64)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/65)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/66)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/67)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/68)