Skip to content

Commit 04c7642

Browse files
endocytosiskc0tlh
andauthored
Update docs/guides/integration/create-with-sdk.md (#178)
* web-publisher: Update docs/guides/integration/create-with-sdk.md * web-publisher: Update docs/guides/integration/create-with-sdk.md * web-publisher: Update docs/guides/integration/create-with-sdk.md --------- Co-authored-by: Alexander Berger <kc0tlh@gmail.com>
1 parent 14ee828 commit 04c7642

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/guides/integration/create-with-sdk.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ function openProjectDemo() {
2828

2929
# {{ $frontmatter.title }}
3030

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.
3232

3333
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.
3434

@@ -94,7 +94,7 @@ Let’s take a look at some of the most crucial parts of the payload first.
9494
### Files
9595

9696
`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:
9898

9999
```js
100100
{
@@ -151,9 +151,9 @@ This is how the title and description look inside a StackBlitz project:
151151

152152
## Options: Customizing your project
153153

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:
155155

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:
157157
```js
158158
{
159159
openFile: 'src/app/index.tsx'

0 commit comments

Comments
 (0)