jazzpeh / gatsby-yaml-boilerplate

A quick starter boilerplate using gatsby + yaml for data driven static website

Quick start

1. Create a Gatsby site.

   Use the Gatsby CLI to create a new site, specifying the yaml starter.

   # create a new Gatsby site using the yaml starter
   gatsby new my-yaml-starter https://github.com/jazzpeh/gatsby-yaml-boilerplate

2. Start developing.

   Navigate into your new site’s directory and start it up.

   cd my-yaml-starter/
   gatsby develop

3. Open the source code and start editing!

   Your site is now running at http://localhost:8000!

   Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

   Open the my-yaml-starter directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

Features

• Data-driven static web development structure using .yaml files
• Proper ESLint for maintaining code standard
• Sass support with linter (using .stylelintrc) for maintaining code standard

License

MIT License

Copyright (c) [2019] [Jazz Peh]

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 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.