Skip to content

Commit 08b98cd

Browse files
committed
Update docs.
1 parent 38437bb commit 08b98cd

6 files changed

Lines changed: 40 additions & 59 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,21 @@ 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:
53+
Open PureStack Studio, the local site wizard:
5454

5555
```sh
56-
npx purestack@latest init my-site --install --yes
57-
cd my-site
58-
yarn dev
56+
npx purestack@latest init
5957
```
6058

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.
59+
Studio prints a link to open in your browser. Name your site, choose a template
60+
and its options, decide whether to install dependencies and set up Git, then
61+
create it. Studio shows each step, starts the live site, and stays open while
62+
you explore. Source edits appear on the live site automatically.
63+
64+
Each project includes `README.md` and `AGENTS.md` to guide customization, plus
65+
dev, build, and publish scripts. Run `npx purestack@latest init --help` for
66+
options that preset Studio's choices, or that create a site without Studio in
67+
scripts and CI.
6968

7069
To assemble a site manually instead, follow the steps below.
7170

‎frontend/components/getting-started/studioSetupStep.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ export interface StudioSetupStep {
55
description: string
66
}
77

8-
const setupStepTemplate = html`<Panel tone="accent" variant="surface" class="p-0 mb-5" bodyClass="p-4">
8+
const setupStepTemplate = html`<Panel tone="accent" variant="solid" class="p-0 mb-5" bodyClass="p-4">
99
<Flex align="center" class="gap-3 mb-3">
10-
<IconFrame name="tabler:browser" tone="accent" variant="surface"/>
10+
<IconFrame name="tabler:browser" tone="accent" variant="solid"/>
1111
<strong>{{ heading }}</strong>
1212
</Flex>
1313
<p class="mt-0 mb-3 fs-sm">{{ description }}</p>
@@ -23,7 +23,7 @@ export function defineStudioSetupStepComponent() {
2323
context: () => ({
2424
heading: 'Configure your site in your browser',
2525
description:
26-
'init starts a local PureStack setup website. Open the URL printed in your terminal to get started.',
26+
'PureStack CLI starts a local PureStack setup website. Open the URL printed in your terminal to get started.',
2727
}),
2828
})
2929
}

‎packages/purestack/README.md‎

Lines changed: 19 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -10,51 +10,35 @@ a page needs it.
1010

1111
## Build your first site
1212

13-
Create a complete project from a template:
13+
Open PureStack Studio, the local site wizard:
1414

1515
```sh
16-
npx purestack@latest init my-site --install --yes
17-
cd my-site
18-
yarn dev
16+
npx purestack@latest init
1917
```
2018

21-
The `starter` template creates a small site with a home page, about page, and
22-
browser TypeScript example. Run `npx purestack@latest init` to serve the wizard's
23-
PureStack content and print its local URL. Configure site details, choose a
24-
template and its settings, and create your project with animated progress.
25-
Use **Browse live site** to open the running project. Studio stays open, and
26-
source edits reload the live site. **Finish Studio** stops both local servers.
27-
Use `--yes` to create projects directly without opening Studio.
19+
Studio prints a link to open in your browser. Configure your site's details,
20+
choose a template and its settings, decide whether to install dependencies and
21+
set up Git, then create the project and follow its progress. Use
22+
**Browse live site** to open the running project. Studio stays open, and source
23+
edits reload the live site. **Finish Studio** stops both local servers.
2824

29-
Studio defaults to `127.0.0.1` and an automatically assigned port. Use
30-
`init --host 127.0.0.1 --port 4700` to choose its listener. Server logging starts
31-
at warning level; creation progress and next steps remain visible.
32-
The wizard is built completely at startup and served with file watching and
33-
live reload disabled.
25+
The `starter` template creates a site with a home page, about page, and
26+
customization guide. Template files become your project's source, and
27+
`AGENTS.md` explains customization and validation. Generated starter projects
28+
provide `yarn dev`, `yarn build`, and `yarn publish`; the latter prepares
29+
`dist/publish` for deployment without uploading anything.
3430

35-
`--install` installs dependencies with the template's package manager (Yarn for
36-
starter), and `--git` initializes a repository.
37-
Both actions are opt-in. `--yes` uses defaults for omitted answers without prompts:
31+
Studio listens on `127.0.0.1` with an automatically assigned port. Command-line
32+
options can preset its choices, for example a folder, template, and options:
3833

3934
```sh
40-
npx purestack@latest init my-site --template starter --git --yes
41-
npx purestack@latest init my-site --template starter --yes
35+
npx purestack@latest init my-site --template starter --set palette=mint
4236
```
4337

44-
You can use an explicit template release, such as `--template starter@1.1.19`,
45-
a full npm package name, or a local package folder or `.tgz` path. Run
46-
`npx purestack@latest init --help` for all options, including `--title`.
47-
The destination must be absent or empty. Template files become your project's
48-
source, and `AGENTS.md` explains customization and validation.
49-
50-
Generated starter projects provide `yarn dev`, `yarn build`, and `yarn publish`.
51-
The latter prepares `dist/publish` for deployment without uploading anything.
52-
53-
Use `--set palette=mint --set search=false` to configure template-defined options
54-
without opening menus. Categories, fields, choices, defaults, and configuration
55-
bindings come from the template's `template.ui.json`. Unspecified values use its
56-
declared defaults. Creation output uses colored Unicode frames and honors
57-
`NO_COLOR`. The browser wizard uses PureStack's existing development server.
38+
Templates can be official aliases, explicit releases such as `starter@1.1.20`,
39+
npm package names, or local folders and `.tgz` archives. Run
40+
`npx purestack@latest init --help` for every option, including `--yes`, which
41+
creates a site without Studio for scripts and CI.
5842

5943
### Create a site manually
6044

‎packages/purestack/src/cli/application.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ import { runWizard } from './wizard/run'
1111

1212
const help = `PureStack
1313
14-
purestack init Open Site Studio
15-
purestack init <directory> --yes Create directly with defaults
14+
purestack init Create a site in Site Studio
1615
purestack serve --content <directory> Preview with live reload
1716
purestack build --content <directory> Build static files
1817
purestack publish --content <dir> Prepare a local release artifact

‎packages/purestack/src/cli/arguments.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const initHelp = `Usage: purestack init [directory] [options]
2323
2424
Start the local PureStack wizard and open the URL printed in your terminal.
2525
Configure your project, create it, and browse the live site in Studio.
26-
Studio stays open until you finish. Use --yes for direct creation.
26+
Studio stays open until you finish. Options below preset its choices.
2727
2828
-t, --template <source> Official alias, npm package, local folder, or .tgz
2929
--title <title> Site title and logo brand
@@ -32,14 +32,13 @@ Studio stays open until you finish. Use --yes for direct creation.
3232
--port <number> Studio port (default: automatic; 0 selects a free port)
3333
--install Install dependencies with the template's package manager
3434
--git Initialize or reuse a Git repository
35-
-y, --yes Create directly without opening Site Studio
35+
-y, --yes Skip Studio and create with these choices (scripts, CI)
3636
-h, --help Show help
3737
3838
Examples:
3939
purestack init
40+
purestack init my-site --template starter --set palette=mint
4041
purestack init --host 127.0.0.1 --port 4700
41-
purestack init my-site --template starter --yes
42-
purestack init my-site --template starter --set palette=mint --install --yes
4342
4443
Installation and Git initialization are opt-in. Relative paths use your current
4544
folder. In this checkout, unversioned official aliases use local templates.`

‎templates/starter/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# PureStack starter template
22

3-
Create a site with `npx purestack@latest init my-site --template starter --yes`.
4-
This package distributes complete project source. It is copied by the CLI and
5-
does not become a dependency of the generated project.
3+
Create a site with `npx purestack@latest init` and choose **Starter** in
4+
PureStack Studio. This package distributes complete project source. It is copied
5+
into your project and does not become a dependency of it.
66

77
The starter includes a responsive home page, About page, customization guide,
88
shared navigation/footer, and an interactive launch checklist. Its custom skin

0 commit comments

Comments
 (0)