Mailchimp Open Commerce docs
This repo hosts the open source documentation for Mailchimp Open Commerce (formerly Reaction Commerce). Previous versions of the Reaction Commerce docs are archived in a separate repo.
Markdown and custom syntax
The files in this repo are the source content for the Open Commerce docs on the Mailchimp Developer site.
To render properly on the developer site, all docs should be written in Markdown. Some standard Markdown elements are not supported: avoid H3, H4, H5, and H6 headers, as well as nested lists.
The developer site does support some Markdown-compatible custom components:
Code snippets
Delimit code blocks with triple backticks as in standard Markdown. You can optionally add a GitHub-flavored Markdown language and a title parameter:
```js title=Example
console.log('hello world');
```
The title parameter cannot contain whitespace, so we recommend only using it for filenames, indicating the location of the referenced code.
Code blocks without a language and title are rendered in a plain module:
``` testing 1 2 3 ```
Note blocks
Create custom note blocks by starting a blockquote with the string **Note**: :
> **Note**: hello there
Other blockquotes will be rendered normally:
> Hello there
Contributing
Contributions to this repo are welcome. Please submit an issue or pull request if you feel any information is incomplete or inaccurate.
Approved changes will also be published on the Mailchimp Developer site, although they will not appear there immediately.