Back to Spree

Spree Commerce Documentation project

docs/README.md

5.4.2840 B
Original Source

Spree Commerce Documentation project

This directory contains the documentation for Spree Commerce located at https://spreecommerce.org/docs.

Contributing

We welcome contributions to the documentation! We use Mintlify to build the documentation.

To run the documentation locally, you will need to install the Mintlify CLI.

[!IMPORTANT] Mintlify requires Node.js version 20+ to run.

bash
npm i -g mint

Then you can run the documentation locally with the following command:

bash
mint dev

This will start the documentation server on port 4000. You can then view the documentation at http://localhost:4000.

License

Documentation located in this directory is licensed under the CC BY 4.0 license.