From 6d589b306721e1fd038138c1e681622c010c87e5 Mon Sep 17 00:00:00 2001 From: Ruben Harutyunyan Date: Wed, 19 Jul 2017 04:03:01 +0400 Subject: [PATCH] (Ready for merge) Adds showcase segment for starters/websites built with Gatsby. (#1535) * Adds the base changes to README. * Adds reference to the showcase in the docs. * Adds details to readme showcase. * Readability fixes. * Adds recently updated bootstrap starter. * Adds websites to the list. * Updates. * Separates Gatsby Starters from README. * Fixes typos, adds more details. * Readability improvements. * Updates to website list. * Makes the disctinction between official/community starters better. * Fixes. * Adds Gatsby advanced starter. --- README.md | 13 +++++ docs/docs/gatsby-starters.md | 88 +++++++++++++++++++++++++++++++ www/src/pages/docs/doc-links.yaml | 3 +- www/src/pages/docs/index.js | 2 + 4 files changed, 105 insertions(+), 1 deletion(-) create mode 100644 docs/docs/gatsby-starters.md diff --git a/README.md b/README.md index 11b9864b6e6c5..56101da6dd610 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,19 @@ ⚛️📄🚀 Blazing-fast static site generator for React +## Showcase + +Websites built with Gatbsy: + +* [Bricolage.io](https://www.bricolage.io/) [(source)](https://github.com/KyleAMathews/blog) +* [Segment's Blog](https://segment.com/blog/) +* [Fabric](https://meetfabric.com/) +* [Formidable](https://formidable.com/) +* [ReasonML Docs](https://reasonml.github.io/) [(source)](https://github.com/reasonml/reasonml.github.io) +* [Jamie Henson's Blog](http://jamiehenson.com/) [(source)](https://github.com/jamiehenson/jh47-gatsby) +* [Sean Coker's Blog](https://sean.is/) +* [Dustin Schau's Blog](https://dustinschau.com/blog/) [(source)](https://github.com/dschau/blog) + ## Docs **[View the docs on gatsbyjs.org](https://www.gatsbyjs.org/docs/)** diff --git a/docs/docs/gatsby-starters.md b/docs/docs/gatsby-starters.md new file mode 100644 index 0000000000000..c20b638a77494 --- /dev/null +++ b/docs/docs/gatsby-starters.md @@ -0,0 +1,88 @@ +--- +title: 'Gatsby Starters' +--- + +The Gatsby CLI tool lets you install "starters". These are +partially built sites preconfigured to help you get moving faster on +creating a certain type of site. + +When creating a new site, you can optionally specify a starter to +base your new site on e.g. + +`gatsby new [SITE_DIRECTORY] [URL_OF_STARTER]` + +For example, to quickly create a blog using Gatsby, you could install +the Gatsby Starter Blog by running: + +`gatsby new blog https://github.com/gatsbyjs/gatsby-starter-blog` + +This downloads the files and initializes the site by running `npm +install` + +If you don't specify a custom starter, your site will be created +from the [default starter](https://github.com/gatsbyjs/gatsby-starter-default). + +There are several starters that have been created. Create a PR to +include yours! + +Official: + +* [gatsby-starter-default](https://github.com/gatsbyjs/gatsby-starter-default) [(demo)](http://gatsbyjs.github.io/gatsby-starter-default/) +* [gatsby-starter-blog](https://github.com/gatsbyjs/gatsby-starter-blog) [(demo)](http://gatsbyjs.github.io/gatsby-starter-blog/) + +Community: + +* [gatsby-material-starter](https://github.com/Vagr9K/gatsby-material-starter) [(demo)](https://vagr9k.github.io/gatsby-material-starter/) + + Features: + * React-MD for Material design + * SASS/SCSS + * Tags + * Categories + * Google Analytics + * Disqus + * Offline support + * Web App Manifest + * SEO + * [Full list here!](https://github.com/Vagr9K/gatsby-material-starter#features) + +* [gatsby-typescript-starter](https://github.com/fabien0102/gatsby-starter) [(demo)](https://github.com/fabien0102/gatsby-starter) + + Features: + * Semantic-ui for styling + * TypeScript + * Offline support + * Web App Manifest + * Jest/Enzyme testing + * Storybook + * Markdown linting + * [Full list here!](https://github.com/fabien0102/gatsby-starter#whats-inside) + +* [gatsby-starter-bootstrap](https://github.com/jaxx2104/gatsby-starter-bootstrap) [(demo)](https://jaxx2104.github.io/gatsby-starter-bootstrap/) + + Features: + * Bootstrap CSS framework + * Single column layout + * Simple components: SiteNavi, SitePost, SitePage + +* [gatsby-blog-starter-kit](https://github.com/dschau/gatsby-blog-starter-kit) + + Features: + * Blog post listing with previews for each blog post + * Navigation between posts with a previous/next post button + * Tags and tag navigation + +* [gatsby-advanced-starter](https://github.com/Vagr9K/gatsby-advanced-starter) [(demo)](https://vagr9k.github.io/gatsby-advanced-starter/) + + Features: + * Great for learning about advanced features and their implementations + * Does not contain any UI frameworks + * Provides only a skeleton + * Tags + * Categories + * Google Analytics + * Disqus + * Offline support + * Web App Manifest + * SEO + * [Full list here!](https://github.com/Vagr9K/gatsby-advanced-starter#features) diff --git a/www/src/pages/docs/doc-links.yaml b/www/src/pages/docs/doc-links.yaml index 7263c3f1213b0..aeb4a2af71fc1 100644 --- a/www/src/pages/docs/doc-links.yaml +++ b/www/src/pages/docs/doc-links.yaml @@ -4,8 +4,9 @@ Migrating from v0 to v1: /docs/migrating-from-v0-to-v1/ Building with Components: /docs/building-with-components/ Querying with GraphQL*: /docs/querying-with-graphql/ - Gatsby Lifecycle APIs: /docs/gatsby-lifecycle-apis/ + Lifecycle APIs: /docs/gatsby-lifecycle-apis/ Deploying: /docs/deploy-gatsby/ + Starters: /docs/gatsby-starters Plugins: /docs/plugins/ PRPL Pattern: /docs/prpl-pattern/ Gatsby on Windows: /docs/gatsby-on-windows/ diff --git a/www/src/pages/docs/index.js b/www/src/pages/docs/index.js index 04d357635e807..e1bcc7a055a08 100644 --- a/www/src/pages/docs/index.js +++ b/www/src/pages/docs/index.js @@ -44,6 +44,8 @@ class IndexRoute extends React.Component { testing your built site. +

Using other starters

+

Running gatsby new installs the default Gatsby starter. There are many other official and community starters you can use to kickstart building your Gatsby site.

Work through the tutorial

Part one of what will be a 4-part tutorial is finished. It walks you