Haleshot commited on
Commit
8f38ddc
·
unverified ·
1 Parent(s): f09994a

Add building and previewing instructions to README for site generation and local testing.

Browse files
Files changed (1) hide show
  1. README.md +15 -0
README.md CHANGED
@@ -58,6 +58,21 @@ Here's a contribution checklist:
58
  If you aren't comfortable adding a new notebook or course, you can also request
59
  what you'd like to see by [filing an issue](https://github.com/marimo-team/learn/issues/new?template=example_request.yaml).
60
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
61
  ## Community
62
 
63
  We're building a community. Come hang out with us!
 
58
  If you aren't comfortable adding a new notebook or course, you can also request
59
  what you'd like to see by [filing an issue](https://github.com/marimo-team/learn/issues/new?template=example_request.yaml).
60
 
61
+ ## Building and Previewing
62
+
63
+ The site is built using a Python script that exports marimo notebooks to HTML and generates an index page.
64
+
65
+ ```bash
66
+ # Build the site
67
+ python scripts/build.py --output-dir _site
68
+
69
+ # Preview the site (builds first)
70
+ python scripts/preview.py
71
+
72
+ # Preview without rebuilding
73
+ python scripts/preview.py --no-build
74
+ ```
75
+
76
  ## Community
77
 
78
  We're building a community. Come hang out with us!