Switch branches/tags
AnushPatel-patch-1 JanoshRiebesell-patch-1 KyleAMathews-patch-1 Partner-program add-depn add-escalade-sports-case-study add-mobile-performance-post add-plugin-documentation alter-blog-post-date amberleyromo-7730-starter-showcase-sourcing amberleyromo-patch-1 array-doclets berrak-responsive-layout calcsam-patch-1 ccustom-algolia-index change-hacktoberfest-title config-api coreyward-patch-1-1 cypress-timeouts docs-rename-starter docs/gatsby-remark-images-sharp documentation-project-blogpost-new-title drop-alpha-support filter-css fix-anchors fix-broken-link fix-doc fix/starter-detail-dependency-grid fix/typescript-reach-router fixes-to-plugin-library gatsby-ssr-silent-fail graphql-filter-sort gvarandas-patch-1 hu0p-patch-1 imagentleman-patch-1 jimt-tutorial-part-two link-container m-allanson-patch-1 marisamorby-swag-store-post master neo/move-prefixPath old-master-3 old-master-4 old-master-6 old-master-7 page-metadata-splitting plugin-blogpost-edit plugin-cli pr/8963 revert-4254-blog-documentation-project revert-5047-update-remark revert-workspaces rfbotto-patch-1 sample-branch-example sebastienfi-wp-orderby-date-asc sharp-images-no-ext sort-chunks starterShowcase2 style-guide-update styled-components-babelrc-config-doc test-builds topics/gatsby-plugin-sharp-tracesvg-fluid topics/inconsistent-accordian-behavior-docs-sidebar topics/using-gatsby-image-design-refresh topics/www-bump-remark-autolink-headers topics/www-sidebar-move-expand-all-down tryzniak-patch-1 update-imagemin-deps v1 v2 valse-disable-default-pageview valse-resolve-env worker
Nothing to show
Find file History
nero2009 and DSchau docs: migrated line highlighting to highlight-line, highlight-start, …
…highlight-end (#10202)

* migrated line highlighting to highlight-line, highlight-start, highlight-end

* Changed highlighting to use valid commenting syntax

* Minor changes

* Update authenication-tutorial.md

Updated this file to workaround changes made by prettier.

* Update using-unstructured-data.md
Latest commit 43fbcbe Dec 7, 2018
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
client-only-paths Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
feed Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
gatsbygram chore: manual eslint fixes (#9750) Nov 6, 2018
hn chore: Format assets (#8622) Nov 6, 2018
image-processing Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
no-plugins Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
no-trailing-slashes Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
simple-auth Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
sitemap Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
styleguide Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-asciidoc Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-contentful update www and example sites deps (#8231) Sep 17, 2018
using-css-modules chore: Format assets (#8622) Nov 6, 2018
using-csv Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-cxs Added Tylermcginnis website (#9619) Nov 6, 2018
using-drupal feat(gatsby-source-drupal): add basicauth support (#9848) Nov 16, 2018
using-emotion-prismjs docs: migrated line highlighting to highlight-line, highlight-start, … Dec 7, 2018
using-emotion chore(examples/using-emotion): update gatsby-plugin-emotion to v3 (#1… Dec 4, 2018
using-excel Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-faker chore: manual eslint fixes (#9750) Nov 6, 2018
using-gatsby-image feat(using-gatsby-image): refresh design, switch to emotion (#9377) Nov 5, 2018
using-gatsby-source-graphql chore(gatsby): remove unused nyc dependency (#10063) Nov 21, 2018
using-glamor Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-hjson Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-javascript-transforms chore: Format assets (#8622) Nov 6, 2018
using-jest chore: Format JS Files (#8623) Nov 6, 2018
using-jss Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-local-plugins chore(gatsby): remove unused nyc dependency (#10063) Nov 21, 2018
using-medium Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-mobx chore: move run-sift (#9549) Nov 6, 2018
using-mongodb Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-multiple-providers Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-page-loading-indicator Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-page-transitions chore: Format assets (#8622) Nov 6, 2018
using-path-prefix Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-prefetching-preloading-modules chore: Format assets (#8622) Nov 6, 2018
using-redirects chore: Format assets (#8622) Nov 6, 2018
using-redux Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-remark-copy-linked-files chore: manual eslint fixes (#9750) Nov 6, 2018
using-remark docs(examples.usingremark): Typo fix (#9965) Nov 16, 2018
using-sass chore: Format assets (#8622) Nov 6, 2018
using-sqip chore: Format assets (#8622) Nov 6, 2018
using-styled-components Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-styled-jsx Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-styletron Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-stylus Add start script to package.json in gatsby/examples/* (#9570) Oct 30, 2018
using-typescript chore(gatsby): remove unused nyc dependency (#10063) Nov 21, 2018
using-unstructured-data chore(gatsby): remove unused nyc dependency (#10063) Nov 21, 2018
using-wordpress update www and example sites deps (#8231) Sep 17, 2018
.gitignore [1.0] Relay Compiler (#912) May 4, 2017
README.md Update README.md (#9458) Oct 26, 2018

README.md

Gatsby example websites

Example websites sit on one or the other end of the spectrum from very basic to complex/complete.

A basic example website should demonstrate a specific technology/plugin/technique to help other developers understand how to accomplish task. They should be named using-* e.g. using-sass.

Complex/complete websites are for studying how to build more complex websites.

Running an example site

  1. Enter one of the sites (e.g. cd gatsbygram)
  2. Install the dependencies for the site npm install
  3. Run the Gatsby development server gatsby develop

Checklist for building an example website

  • Free of errors
  • Has Google Analytics setup
  • Notifications setup to ping PRs on success/failure of build
  • For using-x websites, link to the site from the plugin README and to the plugin(s) from the website.