Skip to content

Document the DOMStack starter with manual setup as an alternative #337

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.

Sign up for GitHub

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

Merged
bcomnes merged 2 commits into from
Sep 19, 2026
Merged

Document the DOMStack starter with manual setup as an alternative #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d2c0f6
Document create-app as the primary getting-started path
bcomnes Sep 19, 2026
22ed3f2
Remove preview command from starter quickstart
bcomnes Sep 19, 2026
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
29 changes: 28 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,34 @@ The [documentation](docs/) covers each convention in detail.

## Installation and first build

Use Node.js 22.18+ within the 22.x release line, or Node.js 24 or newer.
Use Node.js 22.18+ within the 22.x release line, or Node.js 24 or newer, with npm 10 or newer.

### Create a new app

Start a new project with the [DOMStack starter](https://github.com/bcomnes/create-domstack-app#readme):

```sh
npm create @domstack/app@latest my-app
cd my-app
npm run dev
```

The starter prompts for TypeScript or JavaScript and optional JSX, Tailwind CSS, and deployment support.
It installs dependencies and copies DOMStack's default layout, global stylesheet, and client script into `src/` for customization.
Open the development server's URL and edit `src/page.md` to see changes with live reload.

Stop the development server with Ctrl+C, then build the site into `public/`:

```sh
npm run build
```


See the [starter options](https://github.com/bcomnes/create-domstack-app#options) for non-interactive setup and other choices.

### Manual setup alternative

To start without the generator, install DOMStack and create a page yourself.
The v12 prerelease is published under the `beta` npm tag.

In a new project directory:
Expand Down
3 changes: 2 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ dataDeps:
# Documentation

[DOMStack](../) builds websites from ordinary HTML, Markdown, CSS, and JavaScript files.
Start with [Core concepts](../#core-concepts), then follow [Installation and first build](../#installation-and-first-build).
Start with [Core concepts](../#core-concepts), then [create a new app](../#create-a-new-app) with `npm create @domstack/app@latest my-app`.
To set up the files yourself, follow the [manual setup alternative](../#manual-setup-alternative).
Use these references as your project grows.

<!-- The data pipeline discovers docs pages; docsOrder, docsGroup, docsParent, and docsPageOnly frontmatter control their navigation. -->
Expand Down
Loading