Contributing to Docs
All contributions are welcome, please follow the guide below to get started
Getting Started #
Documentation is built using Gatsbyjs.
The main folders and files are in the docs
folder.folder
description
assets
media and fonts
components
general doc components
content
components for pages
navigation
defined routes and subitems
pages
all site pages
styles
limited css styles
utils
useful functions
Setup #
- Fork material-bread repo on github
- Clone the fork to your machine
git clone git@github.com:codypearce/material-bread.git
- Cd into project docs
cd material-bread/docs
- Install dependencies by running
npm i
oryarn
- Start up Gatsby
npm run develop
localhost:8000
.