/reaction-docs

Documentation for Reaction

Reaction Documentation

This repository contains source for Reaction Commerce documentation.

All pushed branches are published to https://docs.reactioncommerce.com

Contributing

Pull requests should be made to the master branches.

Style

Reaction Docs uses remark-lint for linting Markdown style. You can install and use it in this repo by running:

npm install

If you're using Atom, you can install the supported plugin linter-markdown to get linting feedback as you write. If you're using a different editor, see the list of available editor integrations.

Linting

# get lint results for the whole repo in your console
npm run lint

# fix anything that can be fixed automatically
npm run lint-fix

Testing

You can view and test your branch live on https://docs.reactioncommerce.com/.

  1. Go to https://docs.reactioncommerce.com/
  2. Open browser console and run: Meteor.call("redoc/flushDocCache")
  3. Find your branch in the drop-down menu. The URL should change to https://docs.reactioncommerce.com/reaction-docs/your-branch-name/intro and you should be able to see and test your changes here.