Spectacle Documentation
======================

[![Build Status](https://travis-ci.org/FormidableLabs/spectacle-docs.svg?branch=master)](https://travis-ci.org/FormidableLabs/spectacle-docs)

Marketing/documentation site for Spectacle

# Publishing
The site’s documentation section is pulled in directly from the `spectacle` repo’s README, which means it’s only as current as your local `node_modules/spectacle`. To refresh the docs, run `npm run reinstall-spectacle`, which just nukes `spectacle` and reinstalls with the latest. (If you forget this step in dev, it’s run automatically as part of `npm run build-static`, so you can’t accidentally publish outdated docs.)

When it’s time to publish:
```sh
# On master
npm run build-static # Builds site to static HTML/JS in `/build`

# Test the static build in your browser
npm run server-static
npm run open-static

# If all looks good, let's commit and push to GH-pages!
git add build && git commit build -m "Rebuild site"
npm run push-gh-pages
git push origin master
```

Spectacle Documentation
======================

[![Build Status](https://travis-ci.org/FormidableLabs/spectacle-docs.svg?branch=master)](https://travis-ci.org/FormidableLabs/spectacle-docs)

Marketing/documentation site for Spectacle

# Publishing
The site’s documentation section is pulled in directly from the `spectacle` repo’s README, which means it’s only as current as your local `node_modules/spectacle`. To refresh the docs, run `npm update spectacle`. (If you forget this step in dev, it’s run automatically as part of `builder run build-static`, so you can’t accidentally publish outdated docs.)

When it’s time to publish:
```sh
# On master
builder run build-static # Builds site to static HTML/JS in `/build`

# Test the static build in your browser
builder run server-static
builder run open-static

# If all looks good, let's commit!
git add build && git commit build -m "Rebuild site"
git push origin master
```

Once the `build/` is committed, go to [FormidableLabs/formidable.com](https://github.com/FormidableLabs/formidable.com) and update the `spectacle-docs` dependency!

Update instructions for deploying with archetype
Update instructions for deploying with archetype
