Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# build output
dist
packages/*/dist
packages/*/dist-test

# dependencies
node_modules/
Expand Down Expand Up @@ -27,4 +29,4 @@ yarn-error.log*
.astro

# cursor
.cursor
.cursor
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,24 @@ Clone this theme locally and run any of the following commands in your terminal:
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |

## Create a project with the CLI

You can now scaffold projects directly from this starter with the create CLI:

```bash
npm create accessible-astro-starter@latest
```

The CLI walks you through:

- project directory
- site name
- preset selection (`full`, `blog`, `portfolio`, `minimal`, `barebones`)
- whether to keep the Accessible Astro launcher

Generated projects always strip contributor-only workspace tooling such as `scripts/workspace-config.js` and simplify
`astro.config.mjs` accordingly.

## Accessible Astro ecosystem

The Accessible Astro ecosystem is a collection of projects that are designed to help you build accessible web applications. It includes:
Expand Down
167 changes: 141 additions & 26 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 9 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
{
"name": "accessible-astro-starter",
"description": "An Accessible Starter Theme for Astro including several accessibility features and tools to help you build faster.",
"version": "5.1.1",
"version": "5.2.0",
Comment thread
coderabbitai[bot] marked this conversation as resolved.
"author": "Incluud",
"license": "MIT",
"type": "module",
"homepage": "https://accessible-astro-starter.incluud.dev/",
"workspaces": [
"packages/*"
],
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview"
"preview": "astro preview",
"build:cli": "npm --workspace create-accessible-astro-starter run build",
"create:local": "node packages/create-accessible-astro-starter/scripts/run-local.mjs",
"test:cli": "npm --workspace create-accessible-astro-starter run test",
"test:cli:e2e": "npm --workspace create-accessible-astro-starter run test:e2e"
},
"keywords": [
"astro",
Expand Down
31 changes: 31 additions & 0 deletions packages/create-accessible-astro-starter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# create-accessible-astro-starter

Create a new Accessible Astro Starter project with guided presets and optional launcher support.

## Usage

```bash
npm create accessible-astro-starter@latest
```

## Local development

From the starter repo root, run:

```bash
npm install
npm run build:cli
npm run test:cli
```
Comment thread
coderabbitai[bot] marked this conversation as resolved.

From this package directory, use `npm run build` and `npm run test` for package-local checks.

## Test the CLI locally

From the starter repo root, run:

```bash
npm run create:local -- my-demo-site
```

The first positional argument sets the output directory. The later site name prompt only changes generated project metadata.
Loading