diff options
author | 2021-07-30 09:53:24 +0200 | |
---|---|---|
committer | 2021-07-30 00:53:24 -0700 | |
commit | 6d9ef9c0e935e9131dd1addacc2307c41e808a89 (patch) | |
tree | 3422aaf7f00884ef573165c6367d46ea5c201f63 /docs | |
parent | e9d52bd1cc55b4a8f09ce13bebcc0d428acfd5a4 (diff) | |
download | astro-6d9ef9c0e935e9131dd1addacc2307c41e808a89.tar.gz astro-6d9ef9c0e935e9131dd1addacc2307c41e808a89.tar.zst astro-6d9ef9c0e935e9131dd1addacc2307c41e808a89.zip |
Fix typos and clarify docs (#880)
* Add more missing words
* Add missing dot
* Add another missing dot
* Clarify what optimized css means (discussed on Discord)
* Remove oxford comma
Co-authored-by: Fred K. Schott <fkschott@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/src/pages/core-concepts/component-hydration.md | 2 | ||||
-rw-r--r-- | docs/src/pages/guides/deploy.md | 3 | ||||
-rw-r--r-- | docs/src/pages/guides/styling.md | 2 | ||||
-rw-r--r-- | docs/src/pages/reference/renderer-reference.md | 2 |
4 files changed, 5 insertions, 4 deletions
diff --git a/docs/src/pages/core-concepts/component-hydration.md b/docs/src/pages/core-concepts/component-hydration.md index 9aeadb79c..a4c25cf26 100644 --- a/docs/src/pages/core-concepts/component-hydration.md +++ b/docs/src/pages/core-concepts/component-hydration.md @@ -85,7 +85,7 @@ Hydrate the component as soon as the browser matches the given media query (uses [Astro components](./astro-components) (`.astro` files) are HTML-only templating components with no client-side runtime. If you try to hydrate an Astro component with a `client:` modifier, you will get an error. -To make your Astro component interactive, you will need to convert it to the frontend framework of your choice: React, Svelte, Vue, etc. If you have no preference, we recommend React or Preact as most similar to Astro's syntax. +To make your Astro component interactive, you will need to convert it to the frontend framework of your choice: React, Svelte, Vue, etc. If you have no preference, we recommend React or Preact as they are most similar to Astro's syntax. Alternatively, you could add a `<script>` tag to your Astro component HTML template and send JavaScript to the browser that way. While this is fine for the simple stuff, we recommend a frontend framework for more complex interactive components. diff --git a/docs/src/pages/guides/deploy.md b/docs/src/pages/guides/deploy.md index d993aafec..535963da0 100644 --- a/docs/src/pages/guides/deploy.md +++ b/docs/src/pages/guides/deploy.md @@ -68,8 +68,9 @@ By default, the build output will be placed at `dist/`. You may deploy this `dis ### GitHub Actions + 1. In the astro project repo, create `gh-pages` branch then go to Settings > Pages and set to `gh-pages` branch for Github Pages and set directory to `/` (root). -2. Set the correct `buildOptions.site` in `astro.config.mjs` +2. Set the correct `buildOptions.site` in `astro.config.mjs`. 3. Create the file `.github/workflows/main.yml` and add in the yaml below. Make sure to edit in your own details. 4. In Github go to Settings > Developer settings > Personal Access tokens. Generate a new token with repo permissions. 5. In the astro project repo (not \<YOUR USERNAME\>.github.io) go to Settings > Secrets and add your new personal access token with the name `API_TOKEN_GITHUB`. diff --git a/docs/src/pages/guides/styling.md b/docs/src/pages/guides/styling.md index 43dc4f206..1c3c34679 100644 --- a/docs/src/pages/guides/styling.md +++ b/docs/src/pages/guides/styling.md @@ -77,7 +77,7 @@ Styling in Astro is meant to be as flexible as you’d like it to be! The follow ¹ _`.astro` files have no runtime, therefore Scoped CSS takes the place of CSS Modules (styles are still scoped to components, but don’t need dynamic values)_ -All styles in Astro are automatically [**autoprefixed**](#cross-browser-compatibility) and optimized, so you can just write CSS and we’ll handle the rest ✨. +All styles in Astro are automatically [**autoprefixed**](#cross-browser-compatibility), minified and bundled, so you can just write CSS and we’ll handle the rest ✨. --- diff --git a/docs/src/pages/reference/renderer-reference.md b/docs/src/pages/reference/renderer-reference.md index 1433b7814..6ce54df51 100644 --- a/docs/src/pages/reference/renderer-reference.md +++ b/docs/src/pages/reference/renderer-reference.md @@ -11,7 +11,7 @@ Internally, each framework is supported via a framework **renderer.** A renderer A renderer is an NPM package that has two responsibilities: -1. _render a component to a static string of HTML_ at build time +1. _render a component to a static string of HTML_ at build time. 2. _rehydrate that HTML to create an interactive component_ on the client. Take a look at any one of Astro's built-in [`renderers`](https://github.com/snowpackjs/astro/tree/main/packages/renderers) to see this in action. We'll go into more detail in the following sections. |