Unofficial community edition of the Salesforce Commerce Cloud developer documentation.
If you've got Docker Desktop installed, are using VS Code with CLI code enabled, and have the Dev Containers Extension installed, you can click this button to get instantly set up.
You'll need to be using Node v18+ in order to build this project.
# Clone Repository
git clone git@github.com:opensfcc/sfcc-docs.git
# Change into this projects directory
cd sfcc-docs
# Install Dependencies
npm install
# Run All CLI Commands
npm run cli:all
# Start Dev Server
npm run devFinally, open http://localhost:3000 in your browser to view the website.
You can start editing this template by modifying the files in the /src folder. The site will auto-update as you edit these files.
This template includes a global search that's powered by the FlexSearch library. It's available by clicking the search input or by using the ⌘K shortcut.
This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the /src/markdoc/search.mjs file.
To learn more about the technologies used in this site template, see the following resources:
- Tailwind CSS - the official Tailwind CSS documentation
- Next.js - the official Next.js documentation
- Headless UI - the official Headless UI documentation
- Markdoc - the official Markdoc documentation
- Algolia Autocomplete - the official Algolia Autocomplete documentation
- FlexSearch - the official FlexSearch documentation
This website is based on the "Syntax" Tailwind UI site template built using Tailwind CSS and Next.js. This site template is a commercial product purchased by OpenSFCC and is distributed under the Tailwind UI license.
This project meets the following distribution criteria:
Use the Components and Templates to create End Products that are open source and freely available to End Users.
The trademarks and product names of Salesforce®, including the mark Salesforce®, are the property of Salesforce.com. OpenSFCC is not affiliated with Salesforce.com, nor does Salesforce.com sponsor or endorse the OpenSFCC products or website. The use of the Salesforce® trademark on this project does not indicate an endorsement, recommendation, or business relationship between Salesforce.com and OpenSFCC.