diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli.md | 2 | ||||
| -rw-r--r-- | docs/dev.md | 9 | ||||
| -rw-r--r-- | docs/syntax.md | 33 |
3 files changed, 20 insertions, 24 deletions
diff --git a/docs/cli.md b/docs/cli.md index 592cf1635..2ef0592a5 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -36,7 +36,7 @@ Runs the Astro development server. This starts an HTTP server that responds to r See the [dev server](./dev.md) docs for more information on how the dev server works. -__Flags__ +**Flags** ##### `--port` diff --git a/docs/dev.md b/docs/dev.md index 15687d1bb..d9223cbbd 100644 --- a/docs/dev.md +++ b/docs/dev.md @@ -14,7 +14,7 @@ The dev server will serve the following special routes: ### /400 -This is a custom __400__ status code page. You can add this route by adding a page component to your `src/pages` folder: +This is a custom **400** status code page. You can add this route by adding a page component to your `src/pages` folder: ``` ├── src/ @@ -27,13 +27,10 @@ For any URL you visit that doesn't have a corresponding page, the `400.astro` fi ### /500 -This is a custom __500__ status code page. You can add this route by adding a page component to your `src/pages` folder: +This is a custom **500** status code page. You can add this route by adding a page component to your `src/pages` folder: ```astro -├── src/ -│ ├── components/ -│ └── pages/ -│ └── 500.astro +├── src/ │ ├── components/ │ └── pages/ │ └── 500.astro ``` This page is used any time an error occurs in the dev server. diff --git a/docs/syntax.md b/docs/syntax.md index 21f964569..505abeb9b 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -116,26 +116,25 @@ export let name; `.astro` files can end up looking very similar to `.jsx` files, but there are a few key differences. Here's a comparison between the two formats. -| Feature | Astro | JSX | -|------------------------- |------------------------------------------ |---------------------------------------------------- | -| File extension | `.astro` | `.jsx` or `.tsx` | -| User-Defined Components | `<Capitalized>` | `<Capitalized>` | -| Expression Syntax | `{}` | `{}` | -| Spread Attributes | `{...props}` | `{...props}` | -| Boolean Attributes | `autocomplete` === `autocomplete={true}` | `autocomplete` === `autocomplete={true}` | -| Inline Functions | `{items.map(item => <li>{item}</li>)}` | `{items.map(item => <li>{item}</li>)}` | -| IDE Support | WIP - [VS Code][code-ext] | Phenomenal | -| Requires JS import | No | Yes, `jsxPragma` (`React` or `h`) must be in scope | -| Fragments | Automatic | Wrap with `<Fragment>` or `<>` | -| Multiple frameworks per-file | Yes | No | -| Modifying `<head>` | Just use `<head>` | Per-framework (`<Head>`, `<svelte:head>`, etc) | -| Comment Style | `<!-- HTML -->` | `{/* JavaScript */}` | -| Special Characters | ` ` | `{'\xa0'}` or `{String.fromCharCode(160)}` | -| Attributes | `dash-case` | `camelCase` | +| Feature | Astro | JSX | +| ---------------------------- | ---------------------------------------- | -------------------------------------------------- | +| File extension | `.astro` | `.jsx` or `.tsx` | +| User-Defined Components | `<Capitalized>` | `<Capitalized>` | +| Expression Syntax | `{}` | `{}` | +| Spread Attributes | `{...props}` | `{...props}` | +| Boolean Attributes | `autocomplete` === `autocomplete={true}` | `autocomplete` === `autocomplete={true}` | +| Inline Functions | `{items.map(item => <li>{item}</li>)}` | `{items.map(item => <li>{item}</li>)}` | +| IDE Support | WIP - [VS Code][code-ext] | Phenomenal | +| Requires JS import | No | Yes, `jsxPragma` (`React` or `h`) must be in scope | +| Fragments | Automatic | Wrap with `<Fragment>` or `<>` | +| Multiple frameworks per-file | Yes | No | +| Modifying `<head>` | Just use `<head>` | Per-framework (`<Head>`, `<svelte:head>`, etc) | +| Comment Style | `<!-- HTML -->` | `{/* JavaScript */}` | +| Special Characters | ` ` | `{'\xa0'}` or `{String.fromCharCode(160)}` | +| Attributes | `dash-case` | `camelCase` | ### TODO: Styling ### TODO: Composition (Slots) - [code-ext]: https://marketplace.visualstudio.com/items?itemName=astro-build.astro |