Skip to content

Commit 42f6183

Browse files
authored
Update docs; resolve #6623 (#6693)
``` I have read the CLA Document and I hereby sign the CLA ``` ## 📝 Summary Clarified guide page [**"Run as an app"**](https://docs.marimo.io/guides/apps/#layout) to resolve #6623 ## Description - Moved note about `layouts/` folder from `### Grid layout` to `## Layout`, since it applies to both Grid and Slides layouts. - Added instruction to include `layouts/` folder in version control. ## 📋 Checklist - [x] I have read the [contributor guidelines](https://github.com/marimo-team/marimo/blob/main/CONTRIBUTING.md). - [x] For large changes, or changes that affect the public API: this change was discussed or approved through an issue, on [Discord](https://marimo.io/discord?ref=pr), or the community [discussions](https://github.com/marimo-team/marimo/discussions) (Please provide a link if applicable). - [x] I have added tests for the changes made. - [x] I have run the code and verified that it works as expected.
1 parent d323adb commit 42f6183

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/guides/apps.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ While editing a notebook with `marimo edit`, you can preview the notebook
2323
as an app by clicking the preview button in the bottom-right of the editor.
2424
(You can also use the command palette.)
2525

26+
!!! note "`layouts` folder"
27+
marimo saves metadata about your constructed layout in a `layouts` folder;
28+
make sure to include this folder when sharing or deploying your notebook
29+
so that others can reconstruct your layout. Include this folder in version
30+
control.
31+
2632
### Vertical layout
2733

2834
The default layout is the vertical layout: cell outputs are concatenated
@@ -53,10 +59,6 @@ Enable the grid editor in the app preview, via a dropdown:
5359
<figcaption>Grid layout lets you drag and drop outputs to construct your app</figcaption>
5460
</div>
5561

56-
marimo saves metadata about your constructed layout in a `layouts` folder;
57-
make sure to include this folder when sharing your notebook so that others
58-
can reconstruct your layout.
59-
6062
### Slides layout
6163

6264
If you prefer a slideshow-like experience, you can use the slides layout. Enable the slides layout in the app preview, via the same dropdown as above.

0 commit comments

Comments
 (0)