This repository manages the documentation for CoCart.
If you would like to contribute to the documentation to either correct a mistake, maybe add another language or something else. Then please follow these contribution guidelines.
You're going to need:
- Linux or macOS — Windows may work, but is unsupported.
- Ruby, version 2.5 or newer
- Bundler — If Ruby is already installed, but the
bundlecommand doesn't work, just rungem install bundlerin a terminal. - NodeJS
- Fork this repository on GitHub.
- Clone your forked repository (not this original one) to your hard drive with
git clone https://github.com/YOURUSERNAME/co-cart-docs.git cd co-cart-docs- Initialize and start Slate. You can either do this locally, or with Vagrant:
# either run this to run locally
bundle install
bundle exec middleman server ## Load server process for development.
bundle exec middleman build ## Just build the files.
# OR run this to run with vagrant
vagrant upYou can now see the docs at http://localhost:4567.
We have different channels at your disposal where you can find information about the CoCart project, discuss it and get involved:
- 📖 Docs: this is the place to learn how to build amazing sites with CoCart. Get started!
- 👪 Community: use our Slack chat room to share any doubts, feedback and meet great people. This is your place too to share how are you planning to use CoCart!
- 🐞 GitHub: we use GitHub for bugs and pull requests, doubts are solved with the community.
- 🐦 Social media: a more informal place to interact with CoCart users, reach out to us on Twitter.
- 💌 Newsletter: do you want to receive the latest plugin updates and news? Subscribe here.
The documentation is powered by Slate.