@graphcommerce/docs 4.5.1 → 4.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/framework/deployment.md +4 -0
- package/framework/environment-variables.md +4 -0
- package/framework/graphcms.md +4 -0
- package/framework/icons.md +4 -0
- package/framework/readme.md +4 -0
- package/framework/static-generation.md +4 -0
- package/framework/troubleshooting.md +4 -0
- package/getting-started/graphcms-component.md +5 -1
- package/getting-started/header.md +4 -0
- package/getting-started/pages.md +4 -0
- package/getting-started/readme.md +4 -0
- package/getting-started/start-building.md +4 -0
- package/package.json +1 -1
- package/readme.md +4 -0
- package/upgrading.md +15 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Change Log
|
|
2
2
|
|
|
3
|
+
## 4.5.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#1354](https://github.com/graphcommerce-org/graphcommerce/pull/1354) [`90fa8d8b9`](https://github.com/graphcommerce-org/graphcommerce/commit/90fa8d8b90e2a3b33cdbb178a87094888c7befdd) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Small fixes to docs
|
|
8
|
+
|
|
3
9
|
## 4.5.1
|
|
4
10
|
|
|
5
11
|
### Patch Changes
|
package/framework/deployment.md
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
+
<div data-nosnippet>
|
|
2
|
+
|
|
1
3
|
> **Developer preview**
|
|
2
4
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
3
5
|
> updated as GraphCommerce introduces
|
|
4
6
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
5
7
|
|
|
8
|
+
</div>
|
|
9
|
+
|
|
6
10
|
# Deploy a Graphcommerce app with Vercel
|
|
7
11
|
|
|
8
12
|
Congratulations, you are ready to deploy your GraphCommerce storefront to
|
|
@@ -1,8 +1,12 @@
|
|
|
1
|
+
<div data-nosnippet>
|
|
2
|
+
|
|
1
3
|
> **Developer preview**
|
|
2
4
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
3
5
|
> updated as GraphCommerce introduces
|
|
4
6
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
5
7
|
|
|
8
|
+
</div>
|
|
9
|
+
|
|
6
10
|
# Environment Variables
|
|
7
11
|
|
|
8
12
|
This guide describes how to store environment variables in your GraphCommerce
|
package/framework/graphcms.md
CHANGED
|
@@ -2,11 +2,15 @@
|
|
|
2
2
|
menu: GraphCMS
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
+
<div data-nosnippet>
|
|
6
|
+
|
|
5
7
|
> **Developer preview**
|
|
6
8
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
7
9
|
> updated as GraphCommerce introduces
|
|
8
10
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
9
11
|
|
|
12
|
+
</div>
|
|
13
|
+
|
|
10
14
|
# GraphCMS
|
|
11
15
|
|
|
12
16
|
GraphCMS is integrated as a Content Management System. It is used to store all
|
package/framework/icons.md
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
+
<div data-nosnippet>
|
|
2
|
+
|
|
1
3
|
> **Developer preview**
|
|
2
4
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
3
5
|
> updated as GraphCommerce introduces
|
|
4
6
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
5
7
|
|
|
8
|
+
</div>
|
|
9
|
+
|
|
6
10
|
# Icons
|
|
7
11
|
|
|
8
12
|
The GraphCommerce UI looks clean and minimalistic due to the use of icons. This
|
package/framework/readme.md
CHANGED
|
@@ -2,11 +2,15 @@
|
|
|
2
2
|
menu: Overview
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
+
<div data-nosnippet>
|
|
6
|
+
|
|
5
7
|
> **Developer preview**
|
|
6
8
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
7
9
|
> updated as GraphCommerce introduces
|
|
8
10
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
9
11
|
|
|
12
|
+
</div>
|
|
13
|
+
|
|
10
14
|
# GraphCommerce framework overview
|
|
11
15
|
|
|
12
16
|
GraphCommerce is a front-end framework used for building headless Magento
|
|
@@ -6,11 +6,15 @@ metaDescription:
|
|
|
6
6
|
Generation for Magento nextjs PWA out-of-the-box.'
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
+
<div data-nosnippet>
|
|
10
|
+
|
|
9
11
|
> **Developer preview**
|
|
10
12
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
11
13
|
> updated as GraphCommerce introduces
|
|
12
14
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
13
15
|
|
|
16
|
+
</div>
|
|
17
|
+
|
|
14
18
|
# Static Site Generation (SSG) in GraphCommerce
|
|
15
19
|
|
|
16
20
|
Pages that export a function called getStaticProps, will pre-render at
|
|
@@ -1,8 +1,12 @@
|
|
|
1
|
+
<div data-nosnippet>
|
|
2
|
+
|
|
1
3
|
> **Developer preview**
|
|
2
4
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
3
5
|
> updated as GraphCommerce introduces
|
|
4
6
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
5
7
|
|
|
8
|
+
</div>
|
|
9
|
+
|
|
6
10
|
# Troubleshouting
|
|
7
11
|
|
|
8
12
|
## Common build errors
|
|
@@ -3,11 +3,15 @@ menu: 5. Build a GraphCMS component
|
|
|
3
3
|
metaTitle: Build a GraphCMS component
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
<div data-nosnippet>
|
|
7
|
+
|
|
6
8
|
> **Developer preview**
|
|
7
9
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
8
10
|
> updated as GraphCommerce introduces
|
|
9
11
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
10
12
|
|
|
13
|
+
</div>
|
|
14
|
+
|
|
11
15
|
# Build a GraphCMS component
|
|
12
16
|
|
|
13
17
|
Previously, you created a GraphCommerce app and started building a custom
|
|
@@ -45,7 +49,7 @@ frontend React framework that uses Next.js for server-side rendering.
|
|
|
45
49
|
|
|
46
50
|
<figure>
|
|
47
51
|
|
|
48
|
-
![Adding a Single line text field]()
|
|
52
|
+

|
|
49
53
|
|
|
50
54
|
<figcaption>Adding a Single line text field called "Identity"</figcaption>
|
|
51
55
|
</figure>
|
|
@@ -3,11 +3,15 @@ menu: 3. Build a custom header
|
|
|
3
3
|
metaTitle: Build a custom header
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
<div data-nosnippet>
|
|
7
|
+
|
|
6
8
|
> **Developer preview**
|
|
7
9
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
8
10
|
> updated as GraphCommerce introduces
|
|
9
11
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
10
12
|
|
|
13
|
+
</div>
|
|
14
|
+
|
|
11
15
|
# Build a custom header in GraphCommerce
|
|
12
16
|
|
|
13
17
|
Previously, you created a GraphCommerce app and started building your custom
|
package/getting-started/pages.md
CHANGED
|
@@ -3,11 +3,15 @@ menu: 4. Build pages
|
|
|
3
3
|
metaTitle: Build pages
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
<div data-nosnippet>
|
|
7
|
+
|
|
6
8
|
> **Developer preview**
|
|
7
9
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
8
10
|
> updated as GraphCommerce introduces
|
|
9
11
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
10
12
|
|
|
13
|
+
</div>
|
|
14
|
+
|
|
11
15
|
# Build pages in GraphCommerce
|
|
12
16
|
|
|
13
17
|
Previously, you created a custom storefront and started customizing your
|
|
@@ -9,11 +9,15 @@ metaDescription:
|
|
|
9
9
|
template for Magento storefronts'
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
+
<div data-nosnippet>
|
|
13
|
+
|
|
12
14
|
> **Developer preview**
|
|
13
15
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
14
16
|
> updated as GraphCommerce introduces
|
|
15
17
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
16
18
|
|
|
19
|
+
</div>
|
|
20
|
+
|
|
17
21
|
# GraphCommerce magento-graphcms example overview
|
|
18
22
|
|
|
19
23
|
GraphCommerce offers a magento-graphcms example that provides an approachable
|
|
@@ -3,11 +3,15 @@ menu: 2. Customize a storefront
|
|
|
3
3
|
metaTitle: Customize a storefront
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
<div data-nosnippet>
|
|
7
|
+
|
|
6
8
|
> **Developer preview**
|
|
7
9
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
8
10
|
> updated as GraphCommerce introduces
|
|
9
11
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
10
12
|
|
|
13
|
+
</div>
|
|
14
|
+
|
|
11
15
|
# Start building a GraphCommerce custom storefront
|
|
12
16
|
|
|
13
17
|
Previously, you [created a new GraphCommerce app](../getting-started/create.md).
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@graphcommerce/docs",
|
|
3
3
|
"homepage": "https://www.graphcommerce.org/docs",
|
|
4
4
|
"repository": "github:graphcommerce-org/graphcommerce/docs",
|
|
5
|
-
"version": "4.5.
|
|
5
|
+
"version": "4.5.2",
|
|
6
6
|
"sideEffects": true,
|
|
7
7
|
"devDependencies": {
|
|
8
8
|
"@graphcommerce/prettier-config-pwa": "^4.0.2"
|
package/readme.md
CHANGED
|
@@ -8,11 +8,15 @@ metaDescription:
|
|
|
8
8
|
extension.'
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
+
<div data-nosnippet>
|
|
12
|
+
|
|
11
13
|
> **Developer preview**
|
|
12
14
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
13
15
|
> updated as GraphCommerce introduces
|
|
14
16
|
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
15
17
|
|
|
18
|
+
</div>
|
|
19
|
+
|
|
16
20
|
# GraphCommerce
|
|
17
21
|
|
|
18
22
|
GraphCommerce is a front-end framework used for building headless Magento
|
package/upgrading.md
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
|
+
<div data-nosnippet>
|
|
2
|
+
|
|
1
3
|
> **Developer preview**
|
|
2
4
|
> This is a developer preview of GraphCommerce. The documentation will be
|
|
3
5
|
> updated as GraphCommerce introduces
|
|
4
|
-
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases)
|
|
6
|
+
> [new features and refines existing functionality](https://github.com/graphcommerce-org/graphcommerce/releases).
|
|
7
|
+
|
|
8
|
+
</div>
|
|
5
9
|
|
|
6
10
|
# Upgrading
|
|
7
11
|
|
|
@@ -19,17 +23,17 @@ dependencies, while keeping your customizations.
|
|
|
19
23
|
|
|
20
24
|
1. In package.json, find your version:
|
|
21
25
|
|
|
22
|
-
```json
|
|
23
|
-
// Example from package.json
|
|
26
|
+
```json
|
|
27
|
+
// Example from package.json
|
|
24
28
|
|
|
25
|
-
{
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
}
|
|
32
|
-
```
|
|
29
|
+
{
|
|
30
|
+
"dependencies": {
|
|
31
|
+
//...
|
|
32
|
+
"@graphcommerce/next-ui": "^4.2.0"
|
|
33
|
+
//...
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
```
|
|
33
37
|
|
|
34
38
|
2. Download a fresh copy of the repository:
|
|
35
39
|
|