Docs

This is the internal readme for this repo. Because VuePress uses README.md as the root home page, this file was renamed to something different.

Documentation site serves some static documentation content, currently docs, blog, and tutorials.

The goal of this site is to create some solid navigation structure for the content. And enable us to write some content effortlessly using a CMS without writing any code.

Setup

Get your config from your comrade developer and add it to .vuepress folder.

• ex: .vuepress/configDocs-dev.json

Then run some awesome commands to get started:

yarn
yarn serve # stands up the site with some hot reload so you can start cranking 💻
yarn build # builds the site for deployment
yarn deploy # deploys the site (to dev by default)

Gotchas

Don't use the spaces in the asset file names

Images are stored on S3. When you insert some image links, make sure the URL or the file has no spaces.

Sidebar gets generated based on the content files

Sidebar is automatically generated based on the files in the documentation folders. Just add your content there and it'll build the sidebar with it. If you would like to update the sidebar structure, it's in .vuepress/config.js

Use CMD_ENV instead of NODE_ENV

VuePress uses and sets NODE_ENV internally, so use CMD_ENV for this app's purposes.