0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples
Robin Métral 397d8f3d84
Upgrade unified deps and improve unified plugins types (#1200)
* Upgrade @astrojs/markdown-support deps and update types

* Add changeset

* Update changeset

* Switch astro-markdown-plugins example to use rehype-autolink-headings

Usage of remark-autolink-headings is discouraged in favor of the rehype counterpart: https://github.com/remarkjs/remark-autolink-headings\#remark-autolink-headings

* Add stricter types for unified plugins

This includes a few suggestions from a code review:
- use vfile.toString instead of vfile.value.toString
- refactor plugins to follow unified best practices instead of returning functions that return a plugin
- use any instead of any[] for plugin options types

* Narrow down types to more specific hast or mdast typings
2021-08-25 08:17:45 -04:00
..
blog Version Packages (#1217) 2021-08-24 16:11:51 -04:00
blog-multiple-authors Version Packages (#1217) 2021-08-24 16:11:51 -04:00
docs Fix CSS in docs example (#1221) 2021-08-24 16:41:42 -07:00
framework-lit Version Packages (#1217) 2021-08-24 16:11:51 -04:00
framework-multiple Version Packages (#1217) 2021-08-24 16:11:51 -04:00
framework-preact Version Packages (#1217) 2021-08-24 16:11:51 -04:00
framework-react Version Packages (#1217) 2021-08-24 16:11:51 -04:00
framework-solid Version Packages (#1217) 2021-08-24 16:11:51 -04:00
framework-svelte Version Packages (#1217) 2021-08-24 16:11:51 -04:00
framework-vue Version Packages (#1217) 2021-08-24 16:11:51 -04:00
minimal Version Packages (#1217) 2021-08-24 16:11:51 -04:00
portfolio Version Packages (#1217) 2021-08-24 16:11:51 -04:00
snowpack Version Packages (#1217) 2021-08-24 16:11:51 -04:00
starter Version Packages (#1217) 2021-08-24 16:11:51 -04:00
with-markdown Version Packages (#1217) 2021-08-24 16:11:51 -04:00
with-markdown-plugins Upgrade unified deps and improve unified plugins types (#1200) 2021-08-25 08:17:45 -04:00
with-nanostores Version Packages (#1217) 2021-08-24 16:11:51 -04:00
with-tailwindcss Version Packages (#1217) 2021-08-24 16:11:51 -04:00
README.md Docs: npm@7 requires an extra -- for arguments passed to the command, per @natemoo-re's description. (#786) 2021-07-20 20:06:11 -05:00

Astro Examples Library

The easiest way to check out one of these examples on your machine is by running this command in an empty directory:

npm init astro -- --template [EXAMPLE_NAME]

Community Examples

Visit awesome-astro for a full list of community examples. You can use npm init astro to check out any community examples:

npm init astro -- --template [GITHUB_USER]/[REPO_NAME]

Paths to examples nested inside of a repo are also supported:

npm init astro -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example