Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bevry/staticsitegenerators-list

A comprehensive, partially automatically generated comparison of static site generators
https://github.com/bevry/staticsitegenerators-list

List: staticsitegenerators-list

awesome-list static-site-generation static-site-generator

Last synced: 2 days ago
JSON representation

A comprehensive, partially automatically generated comparison of static site generators

Awesome Lists containing this project

README 

        



Static Site Generators Listing



NPM version

NPM downloads

GitHub Sponsors donate button

Patreon donate button

Liberapay donate button

Buy Me A Coffee donate button

Open Collective donate button

crypto donate button

PayPal donate button



A comprehensive, partially automatically generated comparison of static site generators with some minimal meta data about them



-   [View the source listing](https://github.com/bevry/staticsitegenerators-list/blob/master/source/list.ts) | [Edit the source listing](https://github.com/bevry/staticsitegenerators-list/edit/master/source/list.ts)

-   [View the raw JSON listing](https://staticsitegenerators.net/raw.json)

-   [View the rendered JSON listing](https://staticsitegenerators.net/list.json)

-   [View the website](http://staticsitegenerators.net) | [View the website source](https://github.com/bevry/staticsitegenerators-website)



## Contributing



### Requirements



There are generally three types of Content Management Systems:



1. Dynamic Servers (e.g. WordPress, Ghost, DocPad, Harp) — these allow you to have re-render on every request abilities

2. Flat File Content Management Systems (e.g. Yellow, Techy) — these allow you to write your content as files

3. Static Site Generators (e.g. Jekyll, DocPad) — these generate a static website from your input that you can deploy anywhere



Currently, this listing is only for projects that relate to Flat File Content Management Systems and/or Static Site Generators, but not for projects which relate only to Dynamic Servers (such as WordPress and Ghost).



### Adding



Entries are stored within the [`source/list.ts` file](https://github.com/bevry/staticsitegenerators-list/blob/master/source/list.ts).



Entries must conform to the [`RawEntry` type](http://master.staticsitegenerators-list.bevry.surge.sh/docs/interfaces/rawentry).



### Testing



When you submit your pull request, your submission will be automatically tested, so no need to test locally, however if you do wish to, you can:



1. Install [Node.js](https://learn.bevry.me/node/install) (5-15 minutes)



1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/) (5 minutes)



1. Install local dependencies (1 minute)



    ```bash

    npm install

    ```



1. Running the tests (1 minute)



    ```bash

    npm test

    ```



1. Make any changes that the tests indicate, commit your changes, and submit



## Usage



[Complete API Documentation.](http://master.staticsitegenerators.bevry.surge.sh/docs/globals.html)



Using the npm package is done like so:



```javascript

const listing = require('staticsitegenerators')



// get the hydrated data

console.log(listing.hydrated)



// get the raw data

console.log(listing.raw)

```



History



Discover the release history by heading on over to the HISTORY.md file.



Backers



Maintainers



These amazing people are maintaining this project:






Sponsors



No sponsors yet! Will you be the first?



GitHub Sponsors donate button

Patreon donate button

Flattr donate button

Liberapay donate button

Buy Me A Coffee donate button

Open Collective donate button

crypto donate button

PayPal donate button

Wishlist browse button



Contributors



These amazing people have contributed code to this project:






Discover how you can contribute by heading on over to the CONTRIBUTING.md file.



License



Unless stated otherwise all works are:






and licensed under: