gatsby-starter-eleventh

🌱 An opinionated Gatsby starter by Eleventh.

🚀 Quick start

1. Create a Gatsby site.

   Use the Gatsby CLI to create a new site:

   # Create a new Gatsby site using gatsby-starter-eleventh
   gatsby new your-project https://github.com/eleventhlabs/gatsby-starter-eleventh

2. Configure your code editor.

   Install this project's preferred plugins for your code editor of choice. This is highly recommended.

   • EditorConfig (VSCode, Sublime)
   • Emotion, syntax highlighting (VSCode)
   • ESLint (VSCode, Sublime)
   • Stylelint (VSCode, Sublime)

3. Start developing.

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

   cd your-project/
   npm install
   npm start

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

5. Commit your code to GitHub.

   Before committing anything to GitHub, please check that your code is properly formatted with npm run lint. If you set up the preferred plugins for your code editor mentioned above, you'll also get warnings about formatting as you develop!

🧐 What's inside?

Coming soon! Check out this project's dependencies in the package.json in the meantime.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website.

💫 Deploy

This starter comes configured with the gh-pages npm module by default:

npm run deploy

Running this command will build a production version of your site and automatically publish it. From the gh-pages documentation:

Calling this function will create a temporary clone of the current repository, create a gh-pages branch if one doesn't already exist, copy over all files from the base path, or only those that match patterns from the optional src configuration, commit all changes, and push to the origin remote.

If a gh-pages branch already exists, it will be updated with all commits from the remote before adding any commits from the provided src files.

🐛 Bugs

1. Stylelint plugins for code editors break when .babelrc is configured. See:
   • emotion-js/emotion#185
   • stylelint/stylelint#4018

💡 Inspiration

• https://github.com/gatsbyjs/gatsby-starter-hello-world
• https://github.com/ueno-llc/ueno-gatsby-starter