You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/integration/create-with-sdk.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ function openProjectDemo() {
28
28
29
29
# {{ $frontmatter.title }}
30
30
31
-
Sometimes, instead of keeping a set of example project in a GitHub repository, it is more convenient to create them dynamically on the fly. This is often the case when you maintain a documentation with code snippets that you want your users to open in a live environment.
31
+
Sometimes, instead of keeping a set of example projects in a GitHub repository, it is more convenient to create them dynamically on the fly. This is often the case when you maintain a documentation with code snippets that you want your users to open in a live environment.
32
32
33
33
In order to create a project on-demand, use our [SDK](https://www.npmjs.com/package/@stackblitz/sdk). It is a small package (just 2kb gzipped) intended to help in communication between your code and StackBlitz.
34
34
@@ -94,7 +94,7 @@ Let’s take a look at some of the most crucial parts of the payload first.
94
94
### Files
95
95
96
96
`files` is a flat JavaScript object where each key represents a path, and each value is the file's contents.
97
-
For example: in order to create a project with a `readme.md` file and `src` folder that contains `index.js` file inside, your `files` would look something like this:
97
+
For example: in order to create a project with a `readme.md` file and `src` folder that contains an `index.js` file inside, your `files` would look something like this:
98
98
99
99
```js
100
100
{
@@ -151,9 +151,9 @@ This is how the title and description look inside a StackBlitz project:
151
151
152
152
## Options: Customizing your project
153
153
154
-
To further customize your project, you can provide a second argument to the `StackBlitzSDK.openProject` method. The argument is an object that allows to provide optional adjustments:
154
+
To further customize your project, you can provide a second argument to the `StackBlitzSDK.openProject` method. The argument is an object that allows you to provide optional adjustments:
155
155
156
-
-**`openFile`** – StackBlitz displays a file in the editor on page load - depending on a project, that would usually be a readme or the index file. You can specify the featured file:
156
+
-**`openFile`** – StackBlitz displays a file in the editor on page load - depending on the project, that would usually be a readme or the index file. You can specify the featured file:
0 commit comments