cleans up overall configuration of repo (#102)

* cleans up overall configuration of repo
* show code playground by default, hides codesandbox

Author: designmatty

.gitignore

@@ -36,9 +36,6 @@ dist
 .idea
 *.iml
 
-#VSCode metadata
-.vscode
-
 # Mac files
 .DS_Store
 

.travis.yml

@@ -1,2 +1,2 @@
 language: node_js
-script: yarn build && yarn test
+script: npm run build && npm run test

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "editor.formatOnSave": true,
+  "editor.tabSize": 2,
+  "prettier.disableLanguages": ["mdx"],
+  "javascript.validate.enable": false,
+  "javascript.format.enable": false
+}

README.md

@@ -21,8 +21,9 @@ You will need to have installed `styled-components` as well as `styled-system` i
 ### Getting Started
 
 1.  Clone the project: `git clone [email protected]:raster-foundry/blasterjs.git`
-2.  Setup project: `yarn install`
-3.  Run `yarn start`
+    2a. Change node versions: `nvm use` _recommend using nvm for switching node versions_
+    2b. Setup project: `npm install`
+2.  Run `npm run start`
 
 ### Using the CLI
 
@@ -89,17 +90,16 @@ be unable to override them with `styled-system`'s _asymmetric_ shortcuts
 using the asymmetric shortcuts, which a developer can override using either
 asymmetric or symmetric shortcuts.
 
-
 ### Scripts
 
-| Command                                        | Description                                                                                                                                             |
-| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`yarn start`** or<br/> **`./scripts/start`** | This is the most commonly used command when developing locally. <br/> It runs `yarn build`, `lerna bootstrap`, and then starts the styleguidist server. |
-| `yarn bootstrap`                               | An alias for `lerna bootstrap`. <br/> Symlinks the various packages together to enable a smooth monorepo development workflow.                          |
-| `yarn test`                                    | Run tests for all components                                                                                                                            |
-| `yarn build` or <br/> `./scripts/build`        | Uses lerna to run all packages through babel.                                                                                                           |
-| `./scripts/release`                            | Create a new release interactively with Lerna                                                                                                           |
-| `./scripts/clean`                              | Remove all existing `node_modules` directories                                                                                                          |
+| Command             | Description                                                                                                                               |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| **`npm run start`** | This is the most commonly used command when developing locally. It runs `npm run build`, `lerna bootstrap`, and starts the `docz` server. |
+| `npm run bootstrap` | An alias for `lerna bootstrap`. <br/> Symlinks the various packages together to enable a smooth monorepo development workflow.            |
+| `npm run test`      | Run tests for all components                                                                                                              |
+| `npm run build`     | Uses lerna to run all packages through babel.                                                                                             |
+| `npm run release`   | Create a new release interactively with Lerna                                                                                             |
+| `npm run clean`     | Remove all existing `node_modules` directories                                                                                            |
 
 All Lerna [Lerna commands](https://lernajs.io/) are also available.
 
@@ -131,4 +131,4 @@ This means that whenever one package is updated to a new version, all packages a
 
 1.  Ensure all changes have been committed. Publishing will not work if your local version is not up to date with `master`.
 1.  **`npm addUser --scope @blasterjs`** - this ensures you are logged into npm and have sufficient privileges to publish Blaster
-1.  **`./scripts/release`** - this runs `lerna publish --exact`, which is an interactive process. All dependencies are pinned to the versions currently installed. Select the appropriate version bump according to semantic versioning.
+1.  **`npm run release`** - this runs `lerna publish --exact`, which is an interactive process. All dependencies are pinned to the versions currently installed. Select the appropriate version bump according to semantic versioning.

docs/DocsThemeWrapper.js

@@ -1,3 +1,9 @@
+---
+name: Getting Started
+route: /getting-started
+---
+
+
 # Getting started
 
 ## Theme Provider
@@ -20,4 +26,4 @@ class App extends React.Component {
     return <ThemeProvider theme={theme}>...</ThemeProvider>;
   }
 }
-```
+```

docs/introduction.md renamed to docs/GettingStarted.mdx

@@ -0,0 +1,9 @@
+---
+name: Home
+route: /
+order: -1
+---
+
+# BlasterJS
+
+This is the start of something beautiful.

docs/Home.mdx

@@ -4,11 +4,15 @@ export default {
   title: "BlasterJS",
   ignore: "./templates/index.mdx",
   repository: "https://github.com/raster-foundry/blasterjs",
-  ordering: "ascending",
   propsParser: false,
-  debug: true,
+  debug: false,
   description:
     "React Styled-components UI library designed and built by Azavea",
-  indexHtml: "docz/index.html",
-  wrapper: "docz/wrapper.js"
+  indexHtml: "docs/index.html",
+  wrapper: "docs/wrapper.js",
+  menu: ["Home", "Getting Started", "Components"],
+  codeSandbox: false,
+  themeConfig: {
+    showPlaygroundEditor: true
+  }
 };

docs/colors.md

@@ -10,7 +10,7 @@
 # This is the directory that you are publishing from (relative to root of your repo)
   publish = "./.docz/dist"
 # This will be your default build command
-  command = "yarn install && yarn run build-docz"
+  command = "npm install && npm run build-docz"
   environment = { CI = "1" }
 
 [[headers]]