/gatsby-starter-markdown

Primary LanguageJavaScriptMIT LicenseMIT

Gatsby Markdown Starter

Boilerplate for markdown-based website (Documentation, Blog, etc.). Based on gatsby-default-starter.

live demo

Features

  • Responsive Web Design
  • Sidebar
  • Anchor

TODO

  • Footer
  • Optional Sidebar
  • Optional Anchor
  • Sidebar items order
  • Search Funtionality
  • More examples

Plugins

  • gatsby-image
  • gatsby-plugin-manifest
  • gatsby-plugin-offline
  • gatsby-plugin-react-helmet
  • gatsby-plugin-sharp
  • gatsby-remark-images
  • gatsby-remark-autolink-headers
  • gatsby-remark-katex
  • gatsby-source-filesystem
  • gatsby-transformer-json
  • gatsby-transformer-remark
  • gatsby-transformer-sharp

Quick Start

  1. Create a Gatsby site.

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

    gatsby new gatsby-starter-markdown https://github.com/cvluca/gatsby-starter-markdown
  2. Start developing.

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

    cd gatsby-starter-markdown/
    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.