0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
The web framework for content-driven websites. ️ Star to support our work!
Find a file
Erika 6c68f1ab2f
Add JSDoc comments to errors for doc generation (#5355)
* Start adding JSDocs to errors for doc generation

* Progress

* Add titles

* Update with feedback

* Update tests

* Update packages/astro/src/core/errors/README.md

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* Update packages/astro/src/core/errors/README.md

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* Misc tweaks

* Remove unnecessary character

* Fix errors in build not having proper information

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-11-21 13:34:22 -04:00
.changeset Remove temp tailwind config file in finally (#5450) 2022-11-21 12:30:59 -05:00
.devcontainer [ci] format 2022-08-08 17:24:48 +00:00
.github Add JSDoc comments to errors for doc generation (#5355) 2022-11-21 13:34:22 -04:00
.gitpod Gitpod - fix pnpm version error (#4120) 2022-08-02 11:09:16 -05:00
.vscode update prettier width (#2968) 2022-04-02 14:15:41 -06:00
assets new readme (#3237) 2022-05-03 17:06:04 -07:00
examples [ci] release (#5419) 2022-11-17 10:52:42 -05:00
packages Add JSDoc comments to errors for doc generation (#5355) 2022-11-21 13:34:22 -04:00
patches Astro 1.0.0 (#4214) 2022-08-09 11:10:25 -05:00
scripts [ci] release (#5239) 2022-10-31 10:21:09 -04:00
.Dockerfile Add a Github Codespace Config based on gitpod dockerfile (#4185) 2022-08-08 12:22:32 -05:00
.editorconfig Use accessible indentation (#2253) 2021-12-22 16:11:05 -05:00
.eslintignore Enables eslint on the full repo and adds a rule for no only() tests (#3659) 2022-06-22 15:59:49 +00:00
.eslintrc.cjs Suppress eslint warnings (#4953) 2022-10-03 23:37:21 +08:00
.git-blame-ignore-revs Ignore big formatting commit (#3870) 2022-07-08 15:31:10 -05:00
.gitignore chore: fix tests in node 18 (#5266) 2022-11-03 23:31:26 +08:00
.gitpod.yml fix: always get latest pnpm (#4571) 2022-08-31 11:13:06 -05:00
.npmrc Remove shamefully-hoist (#4842) 2022-09-28 23:13:33 +08:00
.nvmrc
.prettierignore .prettierignore: update comment; (#5177) 2022-10-24 10:32:31 -03:00
.prettierrc.js Fix changesets destroying our Astro codeblocks in changelogs (#4227) 2022-08-10 15:30:00 -04:00
CONTRIBUTING.md Add pnpm-merge-driver instructions (#4022) 2022-07-22 12:31:12 -05:00
LICENSE add vite to license 2022-04-24 16:42:39 -07:00
package.json Update language-server and prettier plugin to latest versions (#5327) 2022-11-08 14:37:19 -04:00
pnpm-lock.yaml Use Cloudflare Pages to serve static assets and support _headers, _redirects and _routes.json (#5347) 2022-11-21 21:31:21 +08:00
pnpm-workspace.yaml fix format (#2736) 2022-03-08 15:20:04 -08:00
README.md docs: fix compiler project url (#5401) 2022-11-14 22:12:14 -04:00
SECURITY.md [ci] format 2022-08-08 17:12:48 +00:00
SECURITY_CONTACTS Changes required for a Passing grade from OpenSSF Best Practices (#3718) 2022-08-08 12:11:00 -05:00
STYLE_GUIDE.md Move from yarn to pnpm (#2455) 2022-03-08 15:46:11 -06:00
tsconfig.base.json
tsconfig.json chore: add empty tsconfig to prevent TypeScript from crawling (#4937) 2022-09-30 16:02:39 -05:00
turbo.json [ci] format 2022-08-05 20:15:51 +00:00

Astro logo

Astro is a website build tool for the modern web —
powerful developer experience meets lightweight output.

Install

# Recommended!
npm create astro@latest

# Manual:
npm install --save-dev astro

Looking for help? Start with our Getting Started guide.

Looking for quick examples? Open a starter project right in your browser.

Documentation

Visit our official documentation.

Support

Having trouble? Get help in the official Astro Discord.

Contributing

New contributors welcome! Check out our Contributors Guide for help getting started.

Join us on Discord to meet other maintainers. We'll help you get your first contribution in no time!

Directory

Package Release Notes
astro astro version
create-astro create-astro version
@astrojs/react astro version
@astrojs/preact astro version
@astrojs/solid-js astro version
@astrojs/svelte astro version
@astrojs/vue astro version
@astrojs/lit astro version
@astrojs/deno astro version
@astrojs/netlify astro version
@astrojs/node astro version
@astrojs/vercel astro version
@astrojs/cloudflare astro version
@astrojs/partytown astro version
@astrojs/sitemap astro version
@astrojs/tailwind astro version
@astrojs/turbolinks astro version
@astrojs/alpinejs astro version
@astrojs/image astro version
@astrojs/mdx astro version
@astrojs/prefetch astro version

CII Best Practices

Several official projects are maintained outside of this repo:

Project Repository
@astrojs/compiler withastro/compiler
Astro Language Tools withastro/language-tools

Sponsors

Astro is generously supported by Netlify, Storyblok, and several other amazing organizations.

❤️ Sponsor Astro! ❤️

sponsors