- Documentation: https://docs.saleor.io
- Project homepage: https://saleor.io
- Saleor Core source code: https://github.com/saleor/saleor
- Saleor Dashboard source code: https://github.com/saleor/saleor-dashboard
- Saleor React Storefront source code: https://github.com/saleor/react-storefront
- Make sure you are using Node in version 12+:
node --version- Install project dependencies:
npm install- Run your dev server:
npm start- Build project:
npm run build- Testing build local:
npm run serve/docsCurrentCanarydeveloper documentation./docs/api-referenceAutomatically generated API reference./docusaurus.config.jsDocusaurus configuration file./docusaurus2-graphql-doc-generatorGraphQL API Reference plugin code./sidebars.jsSidebar menu structure./staticStyling and other static files./versioned_docs&/versioned_sidebarsTagged versions of documentation matching the latest Saleor release.
Code and response examples should be inside code blocks with proper language:
```graphql
query {
id
name
}
``````json
{
"errorCode": 400
}
```Use full path to the file to avoid linking to wrong page.
- ✅ Example of good link:
[Attributes](/docs/developer/attributes.mdx) - 🛑 Avoid:
[Attributes](/attributes)
All documentation files use extension:
.mdx- Developer documentation.md- Dashboard documentation
If your page uses custom react components, you are required to use .mdx file extension. Import statement is also required:
## <!-- /docs/developer/export/export-overview.mdx file -->
## title: Exporting Products
import Foo from "@site/components/Foo";
...
<Foo />For charts we are using Mermaid package.
Edit docs by navigating to docs/ and editing the corresponding document:
docs/doc-to-be-edited.md
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---
Edit me...For more information about docs, click here
- Create the doc as a new markdown file in
/docs, exampledocs/newly-created-doc.md:
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---
My new content here..- Refer to that doc's ID in an existing sidebar in
sidebar.js:
// Add newly-created-doc to the Getting Started category of docs
{
"docs": {
"Getting Started": [
"quick-start",
"newly-created-doc" // new doc here
],
...
},
...
}For more information about adding new docs, click here
- Add links to docs, custom pages or external links by editing the headerLinks field of
siteConfig.js:
{
headerLinks: [
...
/* you can add docs */
{
type: "doc",
docId: "dashboard/before-you-start",
label: "Dashboard Manual",
position: "left",
},
/* you can add custom pages */
{ page: 'help', label: 'Help' },
/* you can add external links */
{ href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
...
],
...
}For more information about the navigation bar, click here
- Docusaurus uses React components to build pages. The components are saved as .js files in
./pages/en: - If you want your page to show up in your navigation header, you will need to update
siteConfig.jsto add to theheaderLinkselement:
{
headerLinks: [
...
{ page: 'my-new-custom-page', label: 'My New Custom Page' },
...
],
...
}For more information about custom pages, click here.
Files in /docs/api-reference are generated by @graphql-markdown/docusaurus package. Introduction pages are automatically copied from /template/api-reference.mdx and /template/storefromt/api-reference.mdx files.
To update the API reference:
- Put
schema.graphqllocally into the root of the saleor-docs repository - Run
npm run update-api-reference
The script behind the scenes does several steps:
- The api-reference is generated in
.tmpfolder. - The highlighting script does additional improvements in the generated docs. It makes the Saleor version and required permissions more visible.
- The current references from
docsfolder are being removed and generated references in.tmpfolder are moved to thedocs. - The code examples are being injected. The code examples from the
examplesfolder are being put into corresponding files in the references folder.
Saleor Docs are using Algolia DocSearch for the website search.
DocSearch crawls the website once a week on Friday and aggregates all the content in an Algolia index. This content is then queried directly from the front-end using the Algolia API.
The website's search results are meticulously ranked to enhance user relevance and experience. A custom ranking function, known as pageRank, is employed for this purpose. The ranking strategy prioritizes various content categories as follows:
-
metaPageRank: This takes precedence and is determined by a custom meta attribute, providing a top-tier ranking for specific content. -
Documentation Pages: General documentation pages are next in line for ranking, excluding those generated based on schema API reference and API storefront. -
API Reference Pages: These pages are ranked differently based on the type of operation they represent.
function pageRank(url) {
if (metaPageRank) {
return metaPageRank;
}
if (!/\/api-reference\/|\/api-storefront\//.test(url.pathname)) {
// not part of API reference
return "40";
}
if (/\/mutations\//.test(url.pathname)) {
// mutation
return "30";
}
if (/\/queries\//.test(url.pathname)) {
// query
return "20";
}
return "10";
}
For even finer control over search result rankings, you can manually influence the ranking of specified pages by adding a custom meta attribute - rank - to the page. The rank meta is configured to have the highest priority in Algolia.
To assign a custom rank to a particular page, use the following code snippet:
<head>
<meta name="rank" content="50" />
</head>
In dev mode, Docusaurus serves a debug page with a list of all available routes and config at http://localhost:3000/\_\_docusaurus/debug.
Full documentation can be found on the website.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent