Repository: bevry/staticsitegenerators-website
Branch: master
Commit: 8fe784028d08
Files: 17
Total size: 21.9 KB
Directory structure:
gitextract_xrhql29y/
├── .dependabot/
│ └── config.yml
├── .editorconfig
├── .github/
│ └── FUNDING.yml
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── components/
│ └── project.tsx
├── next-env.d.ts
├── next.config.js
├── now.json
├── package.json
├── pages/
│ └── index.tsx
├── public/
│ ├── robots.txt
│ └── style.css
└── tsconfig.json
================================================
FILE CONTENTS
================================================
================================================
FILE: .dependabot/config.yml
================================================
version: 1
update_configs:
- package_manager: javascript
directory: /
update_schedule: weekly
allowed_updates:
- match:
update_type: security
automerged_updates:
- match:
dependency_type: all
update_type: all
================================================
FILE: .editorconfig
================================================
# 2018 September 26
# https://github.com/bevry/base
root = true
[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = false
indent_style = tab
[{*.mk,*.py}]
indent_style = tab
indent_size = 4
[*.md]
indent_style = space
indent_size = 4
[{*.json,*.lsrules,*.yml,*.bowerrc,*.babelrc}]
indent_style = space
indent_size = 2
[{*.json,*.lsrules}]
insert_final_newline = true
================================================
FILE: .github/FUNDING.yml
================================================
github: [balupton]
patreon: bevry
open_collective: bevry
ko_fi: balupton
liberapay: bevry
custom: ['https://bevry.me/fund']
================================================
FILE: .gitignore
================================================
# 2019 January 26
# https://github.com/bevry/base
# System Files
**/.DS_Store
# Temp Files
**/.docpad.db
**/*.log
**/*.cpuprofile
**/*.heapsnapshot
# Editor Files
.c9/
.vscode/
# Private Files
.env
.idea
.cake_task_cache
# Build Caches
build/
bower_components/
node_modules/
.next/
.pnp/
.pnp.js
# Build Outputs
**/out.*
**/*.out.*
**/out/
**/output/
edition*/
coffeejs/
coffee/
es5/
es2015/
esnext/
docs/
# =====================================
# CUSTOM
# None
================================================
FILE: .travis.yml
================================================
sudo: false
language: node_js
node_js:
- '12'
matrix:
fast_finish: true
allow_failures: []
cache: npm
install:
- eval "$(curl -fsSL https://raw.githubusercontent.com/bevry/awesome-travis/c91c9d5eef34ecb0e92029667fd5052640225fa3/scripts/node-install.bash)"
before_script:
- eval "$(curl -fsSL https://raw.githubusercontent.com/bevry/awesome-travis/c91c9d5eef34ecb0e92029667fd5052640225fa3/scripts/node-verify.bash)"
notifications:
email:
recipients:
secure: EIbhoOvzvqgkAkdnx19xBfE3QtGfn1tEpHF5lgWfnC+3JOQh5DQQtdsIwI/TiZ1b6q9Xwbr9xZTEhKdFE2c/6j0Xoz+x64XcNROo9VDXArZ2H6K43c97DXC56rkAITWZ6VYrMr7SpBsd+TG75LZ8CIYW0ywSKIn84A/irf/jKV0=
================================================
FILE: CONTRIBUTING.md
================================================
# Before You Post!
## Support
We offer support through our [Official Support Channels](https://bevry.me/support). Do not use GitHub Issues for support, your issue will be closed.
## Contribute
Our [Contributing Guide](https://bevry.me/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read.
## Development
### Setup
1. [Install Node.js](https://bevry.me/install/node)
1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/)
1. Setup the project for development
```bash
npm run our:setup
```
### Developing
1. Compile changes
```bash
npm run our:compile
```
1. Run tests
```bash
npm test
```
### Publishing
Follow these steps in order to implement your changes/improvements into your desired project:
#### Preparation
1. Make sure your changes are on their own branch that is branched off from master.
1. You can do this by: `git checkout master; git checkout -b your-new-branch`
1. And push the changes up by: `git push origin your-new-branch`
1. Ensure all tests pass:
```bash
npm test
```
> If possible, add tests for your change, if you don't know how, mention this in your pull request
1. Ensure the project is ready for publishing:
```
npm run our:release:prepare
```
#### Pull Request
To send your changes for the project owner to merge in:
1. Submit your pull request
1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master`
1. By submitting a pull request you agree for your changes to have the same license as the original plugin
#### Publish
To publish your changes as the project owner:
1. Switch to the master branch:
```bash
git checkout master
```
1. Merge in the changes of the feature branch (if applicable)
1. Increment the version number in the `package.json` file according to the [semantic versioning](http://semver.org) standard, that is:
1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases)
1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner
1. `x.y.z` PATCH version when you make backwards-compatible bug fixes
1. Add an entry to the changelog following the format of the previous entries, an example of this is:
```markdown
## v6.29.0 2013 April 1
- Progress on [issue #474](https://github.com/bevry/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/bevry/docpad/issues/165)
- Updated dependencies
```
1) Commit the changes with the commit title set to something like `v6.29.0. Bugfix. Improvement.` and commit description set to the changelog entry
1. Ensure the project is ready for publishing:
```
npm run our:release:prepare
```
1. Prepare the release and publish it to npm and git:
```bash
npm run our:release
```
================================================
FILE: LICENSE.md
================================================
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Website rendering of staticsitegenerators-list
This project is a website rendering of the [Static Site Generators Listing](http://github.com/bevry/staticsitegenerators-list/issues).
The website is created using the following:
- [Zeit Now v2](https://zeit.co/docs/v2/)
- [Zeit Next.js](https://nextjs.org/docs/)
- [React Hooks](https://reactjs.org/docs/hooks-intro.html)
- [TypeScript](http://npmjs.com/package/@zeit/next-typescript)
The project is maintained using the following:
- [Boundation](https://github.com/bevry/boundation)
- [Projectz](https://github.com/bevry/projectz)