@@ -50,6 +50,25 @@ for the markup and browser app model.
5050
5151## Get your first page running
5252
53+ Create a complete project, install its dependencies, and start the preview:
54+
55+ ``` sh
56+ npx purestack@latest init my-site --install --yes
57+ cd my-site
58+ yarn dev
59+ ```
60+
61+ The ` starter ` template creates a small site. You can select it directly with
62+ ` --template starter ` , initialize Git with ` --git ` , or
63+ run ` init ` alone to configure and create a site in the local PureStack wizard.
64+ Studio shows progress, starts the live site, and stays open until you finish.
65+ Use ` --yes ` to create a site directly without opening Studio.
66+ Installation is opt-in with ` --install ` .
67+ Each project includes ` README.md ` and
68+ ` AGENTS.md ` to guide customization, plus build and publish scripts.
69+
70+ To assemble a site manually instead, follow the steps below.
71+
5372### 1. Create a project
5473
5574``` sh
@@ -126,25 +145,25 @@ has a complete example.
126145
127146## Pick your next step
128147
129- | I want to… | Start here |
130- | :--- | :--- |
131- | Configure a site | [ Site configuration] ( https://purestack.studio/guides/getting-started/site-config/ ) |
132- | Build a richer page | [ Component catalog] ( https://purestack.studio/components/ ) |
133- | Add browser behavior | [ PageScript and RegorApp examples] ( packages/purestack/README.md ) |
134- | Understand the CLI | [ CLI guide] ( https://purestack.studio/guides/getting-started/purestack-cli/ ) |
135- | Explore a complete project | [ Sample content] ( packages/ts-ssg/sample-content ) · [ Website source] ( frontend ) |
136- | Work on PureStack itself | [ Contribution guide] ( CONTRIBUTING.md ) |
148+ | I want to… | Start here |
149+ | :------------------------- | :------------------------------------------------------------------------------ --- |
150+ | Configure a site | [ Site configuration] ( https://purestack.studio/guides/getting-started/site-config/ ) |
151+ | Build a richer page | [ Component catalog] ( https://purestack.studio/components/ ) |
152+ | Add browser behavior | [ PageScript and RegorApp examples] ( packages/purestack/README.md ) |
153+ | Understand the CLI | [ CLI guide] ( https://purestack.studio/guides/getting-started/purestack-cli/ ) |
154+ | Explore a complete project | [ Sample content] ( packages/ts-ssg/sample-content ) · [ Website source] ( frontend ) |
155+ | Work on PureStack itself | [ Contribution guide] ( CONTRIBUTING.md ) |
137156
138157<details >
139158<summary ><strong >How PureStack fits together</strong ></summary >
140159
141- | Source | What PureStack does |
142- | --- | --- |
143- | ` siteConfig.json ` | Defines output paths, site identity, themes, navigation, and optional features. |
144- | ` .md ` , ` .mdx ` , ` .rmdx ` | Turn content files into routes and HTML pages. |
145- | Regor components | Render UI into pages at build time. |
146- | ` PageScript ` and ` RegorApp ` | Bundle TypeScript and add browser behavior where requested. |
147- | Static assets | Copies files from the content directory into the site output. |
160+ | Source | What PureStack does |
161+ | --------------------------- | ---------------------------------------------------------------------------- --- |
162+ | ` siteConfig.json ` | Defines output paths, site identity, themes, navigation, and optional features. |
163+ | ` .md ` , ` .mdx ` , ` .rmdx ` | Turn content files into routes and HTML pages. |
164+ | Regor components | Render UI into pages at build time. |
165+ | ` PageScript ` and ` RegorApp ` | Bundle TypeScript and add browser behavior where requested. |
166+ | Static assets | Copies files from the content directory into the site output. |
148167
149168The [ CLI guide] ( https://purestack.studio/guides/getting-started/purestack-cli/ ) covers the
150169commands and options. [ Site configuration] ( https://purestack.studio/guides/getting-started/site-config/ )
@@ -154,24 +173,28 @@ covers navigation, themes, search, sitemap, localization, and output paths.
154173
155174## Repository map
156175
176+ Use [ sites/] ( sites/README.md ) to test the workspace CLI directly. Its shared
177+ instructions are repository files; generated site directories are Git-ignored.
178+
157179The workspace contains the CLI, site generator, UI components, typed HTML/CSS
158180builders, browser scripts, icon providers, and a private VS Code extension.
159181
160182<details >
161183<summary ><strong >Explore the packages and source directories</strong ></summary >
162184
163- | Path | Purpose |
164- | --- | --- |
165- | [ ` packages/purestack ` ] ( packages/purestack ) | Public ` purestack ` package, CLI, and TypeScript API. |
166- | [ ` packages/ts-ssg ` ] ( packages/ts-ssg ) | Content discovery, rendering, routing, builds, and development server. |
167- | [ ` packages/ts-components ` ] ( packages/ts-components ) | Built-in UI components and component metadata. |
168- | [ ` packages/ts-style ` ] ( packages/ts-style ) | Themes, skins, typography, and style generation. |
169- | [ ` packages/ts-css ` ] ( packages/ts-css ) and [ ` packages/ts-html ` ] ( packages/ts-html ) | Typed CSS and HTML builders. |
170- | [ ` packages/ts-page-scripts ` ] ( packages/ts-page-scripts ) | Browser-side behavior used by site components. |
171- | [ ` packages/ts-svg-icons ` ] ( packages/ts-svg-icons ) | SVG icon providers and lookup. |
172- | [ ` packages/ts-ssg-vscode ` ] ( packages/ts-ssg-vscode ) | Private VS Code extension for PureStack content and components. |
173- | [ ` frontend ` ] ( frontend ) | Source for purestack.studio, built with PureStack. |
174- | [ ` packages/ts-ssg/sample-content ` ] ( packages/ts-ssg/sample-content ) | A larger example site with content, components, and browser scripts. |
185+ | Path | Purpose |
186+ | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
187+ | [ ` packages/purestack ` ] ( packages/purestack ) | Public ` purestack ` package, CLI, and TypeScript API. |
188+ | [ ` packages/ts-ssg ` ] ( packages/ts-ssg ) | Content discovery, rendering, routing, builds, and development server. |
189+ | [ ` packages/ts-components ` ] ( packages/ts-components ) | Built-in UI components and component metadata. |
190+ | [ ` packages/ts-style ` ] ( packages/ts-style ) | Themes, skins, typography, and style generation. |
191+ | [ ` packages/ts-css ` ] ( packages/ts-css ) and [ ` packages/ts-html ` ] ( packages/ts-html ) | Typed CSS and HTML builders. |
192+ | [ ` packages/ts-page-scripts ` ] ( packages/ts-page-scripts ) | Browser-side behavior used by site components. |
193+ | [ ` packages/ts-svg-icons ` ] ( packages/ts-svg-icons ) | SVG icon providers and lookup. |
194+ | [ ` packages/ts-ssg-vscode ` ] ( packages/ts-ssg-vscode ) | Private VS Code extension for PureStack content and components. |
195+ | [ ` templates/ ` ] ( templates ) | Official npm template packages, sharing the PureStack product version. |
196+ | [ ` frontend ` ] ( frontend ) | Source for purestack.studio, built with PureStack. |
197+ | [ ` packages/ts-ssg/sample-content ` ] ( packages/ts-ssg/sample-content ) | A larger example site with content, components, and browser scripts. |
175198
176199The remaining workspace packages provide shared types, utilities, rendering,
177200and DOM support.
@@ -197,11 +220,11 @@ run `yarn frontend`; its development server opens at
197220< http://127.0.0.1:4700/ > . See the [ frontend README] ( frontend/README.md ) for
198221the site-specific workflow.
199222
200- | Command | Purpose |
201- | :--- | :--- |
202- | ` yarn lint:ci ` | Check source without modifying files. |
203- | ` yarn test:ci ` | Run the test suite once. |
204- | ` yarn bundle ` | Build distributable packages. |
223+ | Command | Purpose |
224+ | :------------- | :-------------------------------------------- --- |
225+ | ` yarn lint:ci ` | Check source without modifying files. |
226+ | ` yarn test:ci ` | Run the test suite once. |
227+ | ` yarn bundle ` | Build distributable packages. |
205228| ` yarn package ` | Pack non-private workspaces into local tarballs. |
206229
207230---
0 commit comments