Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add view query param #182

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/platform/webcontainers/project-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,29 @@ The default `"auto"` setting enables showing changes as user types, which may pr

A map of default environment variables that will be set in each top-level shell process.

### <var>view</var>

<table>
<tr>
<td>Type</td>
<td><code>"default" | "editor"</code></td>
</tr>
<tr>
<td>Default</td>
<td><code>"default"</code></td>
</tr>
</table>

The `view` option allows you to configure the layout the editor uses at startup.

The available settings are:

- `"default"` (default): Editor & Preview side-by-side
- `"editor"`: Just the Editor, no preview

You can also specify this option under the key `pullRequests` or `issues` to make it different when opening respectively.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"to make it different when opening respectively." this one sounds complex to me.
Does it mean "to open them (pull requests or issues) with the provided view"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test comment for release. Feel free to ignore



## With URL parameters

### <var>startScript</var>
Expand All @@ -144,3 +167,7 @@ You can also run several scripts sequentially using comma-separated values. For
```
https://stackblitz.com/edit/project-id?startScript=build,serve
```

### <var>view</var>

Use the `view` parameter to configure the layout the editor uses at startup. Either `default` or `editor`