This repository contains source for Reaction Commerce documentation.
All pushed branches are published to https://docs.reactioncommerce.com
- Click on
Edit on GitHub
from any Reaction Commerce documentation page. - Click on the ๐๏ธ to enter edit mode.
- Make changes and commit changes with the
Create a new branch for this commit and start a pull request.
option. - Make a pull request against the
master
branch.
Reaction Docs uses remark-lint for linting Markdown style:
- Install command-line tool:
npm install remark-lint
and runnpm run lint
ornpm run lint-fix
- Install a code editor integration: linter-markdown for Atom and more supported editors.
- To link from one documentation page to another, always use
.md
file extension:
[Store Operator Guide](/admin/dashboard.md)
Example: Store Operator Guide
- To link to a specific point within the same page, use a
#
anchor tag:
[Testing](#testing)
Example: Testing
- To link to a specific point in a different page, use both
.md
and#
:
[Variable naming convention](/developer/contributing/styleguide.md#variables)
Example: Variable naming convention
You can view and test your branch live on https://docs.reactioncommerce.com/.
- Go to https://docs.reactioncommerce.com/
- Open browser console and run:
Meteor.call("redoc/flushDocCache")
- 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.