Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/netlify/staticgen
StaticGen.com, A leaderboard of top open-source static site generators
https://github.com/netlify/staticgen
Last synced: about 1 month ago
JSON representation
StaticGen.com, A leaderboard of top open-source static site generators
- Host: GitHub
- URL: https://github.com/netlify/staticgen
- Owner: netlify
- License: mit
- Archived: true
- Created: 2014-04-25T19:15:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-20T17:30:12.000Z (about 4 years ago)
- Last Synced: 2024-09-20T15:50:42.501Z (about 2 months ago)
- Language: JavaScript
- Homepage: http://www.staticgen.com
- Size: 9.08 MB
- Stars: 2,462
- Watchers: 98
- Forks: 556
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - staticgen - StaticGen.com, A leaderboard of top open-source static site generators (JavaScript)
- more-awesome - Static-Site-Generators: staticgen - StaticGen.com, A leaderboard of top open-source static site generators (To Sort)
- awesome-list - staticgen - source static site generators | netlify | 2497 | (JavaScript)
- awesome-awesome - staticgen
README
## :warning: We have moved staticgen.com to jamstack.org/generators
You can still contribute at https://github.com/jamstack/jamstack.org/ or join us on Slack at http://jamstack.slack.com/
---
## staticgen.com
[staticgen.com](http://staticgen.com), a leaderboard of top open-source static site generators.
[](https://app.netlify.com/sites/staticgen/deploys)
## Contributing
Missing a static site generator here? Just fork the repo and add your generator
as a `.md` in the `content/projects` folder.
Make sure to follow the following rules:
- **Static Site Generation:** No "flat-file CMSs" or similar tools. The program must be able to output a static website that can be hosted in places like Netlify, S3 or Github Pages.
- **Open Source:** The generator must have a public repository on Github that we can link to and pull in stats from.
- **Stick to the format:** Fill out all the same fields as the other static site generators in `content/projects`.
- **Short description:** Keep all the details for the body text, keep the description for the overview page short and sweet.
## Usage
Be sure that you have the latest node and npm installed, then clone this repository and run:
```bash
npm install
npm start
```
In order to successfully retrieve Twitter followers and repository stars (GitHub or GitLab), you
will need authentication keys for these services.
For GitHub, all you'll need is a personal access token with the repo and gist scopes. This can be
generated at . For GitLab, you'll also need a personal access
token. This can be generated at . For Twitter,
you need to create an application at to get the necessary tokens. When
deploying, you must set the environment variables per the example below. If you are developing
locally, you can set these in a `.env` file at the root of the repo.
```
GITHUB_TOKEN=examplekey123abc
GITLAB_TOKEN-examplekey123abc
TWITTER_CONSUMER_KEY=examplekey231abc
TWITTER_CONSUMER_SECRET=examplekey321abc
TWITTER_ACCESS_TOKEN_KEY=examplekey231abc
TWITTER_ACCESS_TOKEN_SECRET=examplekey321abc
```
GitHub, GitLab, and Twitter data is cached in the `.tmp` directory, and online in a Gist. If neither
has data newer than 24 hours old, fresh data is fetched from GitHub, GitLab, and Twitter. Fetching
caching occur automatically during the build.
Then visit http://localhost:8000/ - Gatsby will automatically reload when changes occur.
To test a production build locally, do:
```bash
npm run stage
npm run serve
```
To run a production build for deployment:
```bash
npm run build
```
## Netlify
StaticGen.com is built and maintained by [Netlify](https://www.netlify.com), a hosting and automation service for static websites and apps.
## License
StaticGen is released under the [MIT License](LICENSE).
Please make sure you understand its [implications and guarantees](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html).