Commit graph

402 commits

Author SHA1 Message Date
Adam Recvlohe
41aed672ab
Update deploy docs for gitlab pages (#1465) 2021-09-30 15:03:14 -04:00
matthewp
2293fa0530 [ci] yarn format 2021-09-29 18:09:57 +00:00
Risan Bagja Pradana
34ad6598ee
Fix URL to "starter templates" link (#1455)
The `starter templates` link on [Installation](https://docs.astro.build/installation#create-astro) page is currently pointed at 404 page: https://docs.astro.build/examples.

This fix, simply replace the URL with: https://github.com/snowpackjs/astro/tree/main/examples
2021-09-29 14:08:40 -04:00
Pipo
367ebd3d9f
Added installation.md in spanish (#1444)
* Added installation.md in spanish

* Add update to docs/src/config.ts sidebar

Co-authored-by: Felipe Gutiérrez <pipo@pop-os.localdomain>
2021-09-29 14:08:18 -04:00
AsyncBanana
dd4234a5b5
Add script tag example (#1435)
* Add script tag example

Added example of using Astro with client side JavaScript

* Removed partial hydration example comment
2021-09-28 10:25:58 -04:00
Alexey Pyltsyn
6611b6b931
Update Docusaurus performance score (#1447) 2021-09-28 09:11:12 -04:00
arturo
697f17a255
ES docs typo fixes (#1443)
Fixes 3 minor typographical errors in the Spanish documentation
2021-09-27 11:18:02 -07:00
tony-sull
cb5d45bd2f [ci] yarn format 2021-09-24 16:08:26 +00:00
Kyosuke
33b7c91c97
docs: Add Japanese translation of getting started page (#1375) 2021-09-24 18:06:59 +02:00
tony-sull
1baadefa35 [ci] yarn format 2021-09-24 15:51:18 +00:00
YM
ffbc48da97
Update Doc: Getting Starteted in Zh-tw (#1398)
* Update examples in getting started

* Update Online Playgrounds for zh-tw
2021-09-24 17:50:00 +02:00
tony-sull
1a0e5ce2a0 [ci] yarn format 2021-09-24 15:32:42 +00:00
حمد بنقالي
61e3913aca
update [Arabic] getting started page (#1416)
Co-authored-by: X7md
2021-09-24 17:31:21 +02:00
Pimm "de Chinchilla" Hogeling
60d8191619
Fix typo (odpracht→opdracht) (#1425) 2021-09-24 13:23:19 +02:00
Philip Weber
193b8c503d
docs: German: Change some wording and punctuation (#1388) 2021-09-24 13:18:14 +02:00
AsyncBanana
66e9e41e4a
Add Zola comparison (#1423)
* Add Zola comparison

A Zola comparison has been added to the Astro comparison page

* Fixed naming in docs
2021-09-23 20:23:59 -05:00
Knniff
0012a01541
📘 DOC: show how to pass props (#1381)
* show how to pass props

In the current documentation it is only shown how to receive props but not how to pass a component said props.

This adds a bit of code which shows how to pass props to a component.

* Update docs/src/pages/core-concepts/astro-components.md

Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>
2021-09-23 20:23:35 -05:00
Brandon Stephens
bc01a49e33
update code to match description (#1422) 2021-09-23 19:52:26 -05:00
jasikpark
2ac02255a3 [ci] yarn format 2021-09-23 17:51:08 +00:00
Roman Walters
7414113065
Update deploy.md with information how to deploy to render.com (#1391) 2021-09-23 12:49:56 -05:00
Roman Walters
b3f34bfd0e
Update astro-pages.md: Create custom 404 error page (#1392)
* Update astro-pages.md

* Update astro-pages.md

Explained the speciallity of 404.astro

* Update astro-pages.md
2021-09-20 13:56:25 -07:00
Drew Powers
939d5c3ae6
Add sponsorship logos (#1371) 2021-09-16 22:24:27 -06:00
rawknuckles
769940a6eb
Order deploy host list alphabetically (#1384)
* Add AWS label to S3 bucket link.
2021-09-16 16:57:43 -07:00
Fred K. Schott
b0a7e79bd0
Update getting-started.md 2021-09-16 11:16:04 -07:00
Jonathan Neal
98d785af1d
Expose slots to components (#1368)
* Expose slots to components via Astro.slots

* test: Add Astro.slots API tests

* docs: Document Astro.slots API

* docs: Duplicate Astro.slots documentation to other api-reference markdown

* Update proposal to use booleans, based upon RFC feedback

* update implementation & tests based on request

* changeset
2021-09-15 11:27:59 -04:00
github-actions[bot]
3d9b665265
Version Packages (#1358)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2021-09-14 17:22:50 -07:00
Cassidy Williams
5237db20b9
Update deployment docs for Netlify deployment (#1361)
* Update build command for Netlify

* Clarify directions for Netlify deploy versions

* Create deploy.md

* Update deploy.md

* Update deploy.md

Co-authored-by: Fred K. Schott <fkschott@gmail.com>
2021-09-14 16:25:49 -07:00
Matthew Phillips
b6a75494b1
Add types to examples and docs (#1347)
* Adds a changeset

* Add types to examples and docs

* Make changes based on review feedback

* Avoid using the variable named props

* Make path a const
2021-09-14 09:14:39 -04:00
Marcus Otterström
b0a84a221b
Fix typo (#1360) 2021-09-13 18:36:04 -07:00
Tc001
6b8630c641
Disclaimer for Github pages / jekyll quirk (#1355)
* Added GH pages disclaimer

* Added changeset

* Reworded disclaimer

* Correct GH Pages casing

* Update deploy.md

Co-authored-by: Fred K. Schott <fkschott@gmail.com>
2021-09-13 15:39:45 -07:00
Caleb Jasik
0b73a093ee
Update netlify deploy instructions for .nvmrc syntax (#1337) 2021-09-08 12:42:25 -05:00
FredKSchott
d2c2b1b55e [ci] yarn format 2021-09-08 17:37:14 +00:00
Aleš Vaupotič
d1370e9d69
Opening app to all IPs instead of localhost (#1339)
I see people often ask about opening up the app to local network so this looked like a good place to explain how to do it.
2021-09-08 10:36:00 -07:00
FredKSchott
105be57f80 [ci] yarn format 2021-09-07 18:41:08 +00:00
Fred K. Schott
bf4ba7c3ee
📘 DOC: New "Publish to npm" documentation (#1323)
* new publish docs

* Minor cleanup

- Removed trailing whitespaces.
- Fixed a typo where `components` was misspelled.
- Moved all links to references at the bottom of the file.
- On line 162, I added bash for the file tree example as it was used for the previous example on line 29.
- Added a new line between examples that had a DO and DO NOT.
  - The code snippet from line 85 is a good example. Having that li'l space made it much nicer to read.

* cleanup publish docs

* add note on experimental nature of npm package support

Co-authored-by: Devin W. Leaman <git@4lch4.email>
2021-09-07 11:39:36 -07:00
Fred K. Schott
d67fddfbec docs: small themes copy updates 2021-09-06 22:49:23 -07:00
Fred K. Schott
ef09c3d3bf fix type on themes.json 2021-09-06 09:39:06 -07:00
Fred K. Schott
8963b6607a fix bad import 2021-09-06 01:42:58 -07:00
FredKSchott
5fe677d69c [ci] yarn format 2021-09-06 08:32:22 +00:00
Fred K. Schott
9f06fb014b cleanup docs changes 2021-09-06 01:31:10 -07:00
FredKSchott
b4d1c9bc64 [ci] yarn format 2021-09-06 08:25:23 +00:00
Fred K. Schott
6dc05575a6 scale back the examples page 2021-09-06 01:21:55 -07:00
aFuzzyBear
d321d8366b Adds examples page 2021-09-06 01:21:39 -07:00
jasikpark
e686c3c504 [ci] yarn format 2021-09-05 15:31:20 +00:00
Sam Chen
ab661c575d
docs: set +/- prefix to non-selectable (#1316) 2021-09-05 10:22:46 -05:00
Sam Chen
8c69275f03
docs: add a link to next article (#1308) 2021-09-05 10:16:44 -05:00
Caleb Jasik
73a98821b7
📘DOC: Fix URL normalization for the Left Sidebar in docs (#1299)
* Fix URL normalization for the Left Sidebar in docs

* Move the fix into `util.ts` as suggested by @FredKSchott
2021-09-04 19:55:55 -05:00
Sam Chen
0555689b8a
docs: add a period (#1306) 2021-09-03 22:07:30 -05:00
FredKSchott
e516f9c953 [ci] yarn format 2021-09-03 18:07:39 +00:00
Fred K. Schott
e282e8e4ac
Add new <Code> component, to succeed <Prism> (#1208)
* add code component

* Update packages/astro/components/Debug.astro

Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>

* Update packages/astro/components/Debug.astro

Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>

* fix format in debug component

* remove Debug changes

* add wrap support

* add props docs

* update default theme

Co-authored-by: Peter Singh <drgaud@hotmail.com>
Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>
2021-09-03 11:06:25 -07:00
raph_5
cdc69792f9
Debug component importation (#1289)
with   import { Debug } from 'astro/debug'   :
   Debug = undefined
   Error: Unable to render Debug because it is undefined! Did you forget to import the component or is it possible there is a typo?
2021-09-01 15:03:25 -07:00
Hendrik Runte
d96d6d453d
Update getting-started.md (#1281)
Fixing some minor typos and improving style.
2021-09-01 15:01:46 -07:00
Mani Gandham
ef1ce95407
Delete docs text about removed Collections API (#1286) 2021-08-31 22:27:41 -07:00
Tim Chesney
66734b75f1
Remove reference/link to Collections (#1277)
* Remove reference/link to Collections

Remove line that refers to 'Core Concepts - Collections' given this is now deprecated.

* Added reference to routing

Tested link as working in local build.
2021-08-31 18:04:26 -07:00
Caleb Jasik
61e4f2cb1f
Remove caveat about Astro.request not being passed to components. (#1276) 2021-08-31 13:58:52 -04:00
FredKSchott
6c3416ef44 [ci] yarn format 2021-08-31 15:55:47 +00:00
Lachlan Young
5b24bd1768
Add v20 documentation for bundling assets (#1262)
* Add v20 documentation for bundling assets

* 🛁 Revert bad doc

* 🛁 Address CR

*  Use astro

* 🛁 Correct Link

* Update styling.md

Co-authored-by: Fred K. Schott <fkschott@gmail.com>
2021-08-31 08:54:35 -07:00
Xinyuan Wang
327d59287f
docs: translate astro vs other docs to zh comparing-astro-vs-other-tools.md (#1199)
* translate getting-started.md into ZH (CN & TW)

* fix translate the title for getting-started.md

* add zh CN & TW config in Docs

* fix config "locale"

* fix config.ts add route for CN & TW

* fix installation.md Next Steps title 's level

* translate quick-start.md &
installation.md & examples.md
into ZH (CN )

* Add lang variable to docs frontmatter
for translations

* Update docs/src/pages/zh-TW/getting-started.md

Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>

* docs: translate astro vs other docs to zh
comparing-astro-vs-other-tools.md

* Version Packages

* [ci] yarn format

* fix: Merge conflicts

* docs: add the part of gatsby

* [ci] yarn format

Co-authored-by: Caleb Jasik <calebjasik@jasik.xyz>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: ChelesteWang <ChelesteWang@users.noreply.github.com>
2021-08-30 14:21:04 -07:00
Drew Powers
5b6c52eb41
Alphabetize API doc (#1270) 2021-08-30 14:15:20 -07:00
Sarah Rainsberger
3d73d7fbf2
Include lang="xxxx" in Prism component example (#1264) 2021-08-29 11:39:39 -05:00
Mikkel Tønder
9823f16f51
Add danish translation of the getting started page (#1243)
* Add danish translation of the getting started page

* Add danish to KNOWN_LANGUAGES
2021-08-27 16:01:06 -04:00
github-actions[bot]
3bb97ea328
Version Packages (#1246)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2021-08-27 10:46:14 -04:00
matthewp
5cc7947a58 [ci] yarn format 2021-08-27 14:13:41 +00:00
Matthew Phillips
788c769d78
Implementation of hoisted scripts (#1178)
* Implementation of hoisted scripts

* Use the facade id

* Adds docs on hoisted scripts

* Don't try to run rollup if there are no hoisted scripts

* Handle scripts possibly being undefined (client:only)

* Get rid of changes to the portfolio example

* Adds a changeset

* Remove a todo

* Fix lint errors

* Rename TransformResult property to hoistedScripts

* Move Hoisted Scripts docs to astro-components page

* Fixes lint errors

* Fix path join for windows
2021-08-27 10:12:27 -04:00
matthewp
dc493b39f7 [ci] yarn format 2021-08-27 13:42:16 +00:00
Matthew Phillips
4c4c797020
Update Tailwind docs for path to css (#1240)
* Update Tailwind docs for path to css

* Remove other references to public in the styling guide

* Remove unnecessary (pages)
2021-08-27 09:40:40 -04:00
matthewp
c8c9917c1d [ci] yarn format 2021-08-27 12:27:58 +00:00
Mark Teekman
110fdb1ac1
Add new Astro components package (#1242) 2021-08-27 08:26:18 -04:00
FredKSchott
59cc62f7bd [ci] yarn format 2021-08-26 19:10:14 +00:00
Fred K. Schott
ff92be637f
add "astro preview" command (#1226)
* add "astro preview" command

* Update green-buttons-reflect.md

* Update cli-reference.md
2021-08-26 12:08:52 -07:00
Fred K. Schott
155676275b remove unpublished blog post from docs 2021-08-26 11:25:54 -07:00
github-actions[bot]
c83d481733
Version Packages (#1228)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2021-08-26 12:56:36 -04:00
FredKSchott
d3499fc6dd [ci] yarn format 2021-08-26 04:45:36 +00:00
Rafid Muhymin Wafi
d6798d7ae6
added bengali translation of the getting started page (#1215) 2021-08-25 21:44:26 -07:00
semvis123
4d7dccfb58
NL docs typo fixes (#1232)
Fixes 2 small typos in the Dutch documentation
2021-08-25 14:57:31 -04:00
Anneke Sinnema
72d3dd00ee
Update getting-started.md (#1231) 2021-08-25 14:56:37 -04:00
matthewp
c819b3dade [ci] yarn format 2021-08-25 16:12:44 +00:00
حمد بنقالي
7ea0cb3368
Arabic getting-started translation (#1166)
Co-authored-by: = <=>
2021-08-25 12:11:29 -04:00
E. Berke KARAGÖZ
f097c88d2e
Fix typo Mardown on line 219 (#1229) 2021-08-25 12:09:56 -04:00
Fred K. Schott
96ecb3da5f
docs: fix header rtl logo view (#1224) 2021-08-25 08:18:04 -04:00
FredKSchott
3835856f2b [ci] yarn format 2021-08-24 05:32:44 +00:00
Joohoon Cha
b3a1c0cdcc
[i18n][Docs] Add Korean Translation of Getting Started page (#1189)
* translate getting-started.md into KR

* add kr to KNOWN_LANGUAGES

* add kr config to sidebar

* add kr option to the language selector
2021-08-23 22:31:24 -07:00
FredKSchott
884a2ea76a [ci] yarn format 2021-08-23 21:17:45 +00:00
Fred K. Schott
2538325a46 fix docs on config api 2021-08-23 14:16:29 -07:00
matthewp
010c71e16a [ci] yarn format 2021-08-23 20:44:36 +00:00
Caleb Jasik
efb41f22c3
Add Astro <Debug/> component (#675)
* Initial MVP Debug component

* Document the prettifying of the input

* Just make `<Debug/>` a wrapper around `<Prism/>` lol

* feat: add details/summary debug component

* chore: remove Props (unused)

* fix: prefer `div` to semantic elements

* chore: format

* fix: prop-drill `class` into components

* fix: ensure `astro/components` are evaluated lazily

* feat(debug): export debug component from `astro/debug`

* fix: minimal example local snowpack config

* docs: add debugging docs

* chore: add changeset

* docs: update debug docs

Co-authored-by: Nate Moore <nate@skypack.dev>
2021-08-23 16:43:22 -04:00
Caleb Jasik
2fd004dcd9
Add a titleClosure to the HeadSEO.astro component (#1140)
* Testing out adding a `titleClosure` to the `HeadSEO.astro` component

I think the api needs a bit of improvement, but the basic idea is you can pass this in to a published astro component for specifying how you want it to format your title!

* Refactor to make it pretty

* Rename the `titleClosure()` prop to `formatTitle()` to be more clear

* Use title, with site title as the fallback (#1143)

See og:title guidance (https://developers.facebook.com/docs/sharing/webmasters/)

Co-authored-by: Jonathan Neal <jonathantneal@hotmail.com>
2021-08-23 15:08:20 -05:00
Fred K. Schott
c06da5dd78
Add trailingSlash & pageDirectoryUrl config options (#1197) 2021-08-23 12:05:01 -07:00
matthewp
1185d8ffcb [ci] yarn format 2021-08-23 18:55:00 +00:00
Fred K. Schott
e03f39a1b3
fix the rtl search bar view (#1177) 2021-08-23 14:53:44 -04:00
Fred K. Schott
d51e0f4fef update universal id 2021-08-20 22:48:32 -07:00
headapplesgithub
f235c84972
Update getting-started.md (#1182)
corrected typo "quickly" to "quick"
2021-08-20 13:13:43 -07:00
FredKSchott
aaef6aefef [ci] yarn format 2021-08-20 15:54:37 +00:00
headapplesgithub
68294f777d
Update comparing-astro-vs-other-tools.md (#1169)
Removed duplicate paragraph in the section about Eleventy vs Astro performance.

Co-authored-by: Fred K. Schott <fkschott@gmail.com>
2021-08-20 08:53:12 -07:00
mundry
cdbe2e486d
Fix typos in the docs. (#1165)
Co-authored-by: mundry <mundry@users.noreply.github.com>
2021-08-19 17:56:58 -06:00
Jonathan Neal
e66872125d
add dev script, switch documentation from advising start to dev script (#1141) 2021-08-18 22:07:08 -07:00
Fred K. Schott
a79b6db152
Add Vitepress to "Astro vs. X" comparison page 2021-08-18 18:13:20 -07:00
drwpow
737c10101a [ci] yarn format 2021-08-18 23:46:47 +00:00
Marcus Otterström
b5e5dcfed0
[DOCS] Add more information about content.astro (markdown) (#1148)
* Correct heading levels

* Add more info about content.astro

* Remove accidental heading
2021-08-18 17:45:35 -06:00
kelvinsjk
52cf927564
docs: fix mobile sidebar toggle (#1158) 2021-08-18 15:03:26 -07:00