Awesome
Open SDG - Site starter
This is a starter repository to help in implementing the Open SDG platform. See here for documentation.
Requirements
Usage
| Command | Description |
|---|---|
bundle install | install the current dependencies |
bundle exec jekyll build | build the site. dumps to _site |
bundle exec jekyll serve | builds the site and serves it locally |
Publication
- the static sites created using this repo are configured to be published by pages.cloud.gov via webhooks. For more information on cloud.gov pages visit the website
Requirements
NOTE: You must build this repo with Ruby 2.6.0.
Setup
After you've confirmed the above requirements, all lifecycle operations can be run with NPM scripts (ex. npm run build)
| NPM Command | Description |
|---|---|
| build | Build the site |
| setup | Install ruby gems |
| start | Serve a local build |
| test | Check for broken internal links |
| qa | Check for broken external links |
Contributing
See CONTRIBUTING for additional information.
This site is automatically published based on the branch.
Public domain
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.