History

Nate Moore 17c02925c5 Migrate to new config (#2962 ) * wip: config migration * fix: formatting * refactor: projectRoot -> root * refactor: pageUrlFormat -> format * refactor: buildOptions.site -> site * refactor: public -> publicDir * refactor: dist -> outDir * refactor: styleOptions -> style * fix: some dist tests -> outDir * refactor: remove legacyBuild (with TODOs) * refactor: more legacyBuild cleanup * refactor: server host and port * fix: remove experimentalStaticBuild CLI flag * refactor: src -> srcDir * refactor: devOptions.trailing -> trailing * refactor: remove sitemap + related flags * refactor: experimentalSSR -> experimental.ssr * fix: last devOptions * refactor: drafts -> markdown.drafts * fix: TS error on port as const * refactor: remove pages * refactor: more --project-root updates * refactor: markdownOptions -> markdown * fix: remaining type errors * feat: update AstroUserConfig * refactor: update CLI flag mapper + server mapper * fix: loadFixture projectRoot * fix: merge CLI flags before validating / transforming * wip: attempt to fix bad createRouteManifest config * refactor: combine config.base and config.site * fix: skip route manifest test for now * fix: site and base handling * refactor: update failing config testes * fix: build failure * feat: update config types with migration help * chore: update types * fix(deno): update deno fixture * chore: remove config migration logic * chore: remove logLevel * chore: clean-up config types * chore: update config warning * chore: add changeset * Sitemap Integration (#2965) * feat: add sitemap filter config option * feat: add canonicalURL sitemap config option * docs: update sitemap README * fix: update for new config * fix: filter not being applied * chore: changeset Co-authored-by: bholmesdev <hey@bholmes.dev> * fred pass * fix: Astro.resolve typo * fix: public => publicDir Co-authored-by: bholmesdev <hey@bholmes.dev> Co-authored-by: Fred K. Schott <fkschott@gmail.com>		2022-04-02 12:29:59 -06:00
..
demo	Implement new default `script` behavior, `style is:global` (#2961 )	2022-04-02 12:34:25 -05:00
packages/my-component	Use accessible indentation (#2253 )	2021-12-22 16:11:05 -05:00
.gitignore	chore(.gitignore): remove pnpm error logs from git (#2938 )	2022-03-30 10:41:53 -05:00
.npmrc	Move from yarn to pnpm (#2455 )	2022-03-08 15:46:11 -06:00
.stackblitzrc	Add Component Example (#2203 )	2021-12-17 08:47:59 -05:00
package.json	Migrate to new config (#2962 )	2022-04-02 12:29:59 -06:00
pnpm-workspace.yaml	fix format (#2736 )	2022-03-08 15:20:04 -08:00
README.md	Add Component Example (#2203 )	2021-12-17 08:47:59 -05:00
sandbox.config.json	Add Component Example (#2203 )	2021-12-17 08:47:59 -05:00

README.md

Astro Starter Kit: Component

npm init astro -- --template component

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── demo/
│   ├── public/
│   └── src/
│       └── pages/
│           └── index.astro
└── packages/
    └── my-component/
        ├── index.js
        └── package.json

This project uses workspaces to develop a single package, @example/my-component, from packages/my-component. It also includes a demo Astro site for testing and demonstrating the component.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
`npm install`	Installs dependencies
`npm run dev`	Starts local dev server at `localhost:3000`
`npm run build`	Build your production site to `./dist/`
`npm run preview`	Preview your build locally, before deploying

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.