Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

5.0.0 beta docs #9240

Merged
merged 356 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from 37 commits
Commits
Show all changes
356 commits
Select commit Hold shift + click to select a range
e441857
[BETA] ci: update reference docs (#9378)
astrobot-houston Sep 11, 2024
d3d0575
Add loader reference to the beta docs (#9374)
ascorbic Sep 11, 2024
9ed5378
Typo
ascorbic Sep 11, 2024
b56a2d4
fix a content collections link
sarah11918 Sep 11, 2024
860373e
make links pass
sarah11918 Sep 11, 2024
ebc1ed4
see if reverting helps
sarah11918 Sep 11, 2024
d1c6309
Merge branch 'main' into 5.0.0-beta
yanthomasdev Sep 11, 2024
6c01cb6
yan vs `rendering.mdx`
yanthomasdev Sep 11, 2024
583241d
yan vs `defining-collections.mdx`
yanthomasdev Sep 11, 2024
57ca906
yan vs `environment-variables.mdx`
yanthomasdev Sep 11, 2024
4a57ccf
fix unfixed typo in `markdown-content.mdx`
yanthomasdev Sep 11, 2024
f8f7df9
yan vs `on-demand-rendering.mdx`
yanthomasdev Sep 11, 2024
d8d4db9
yan vs `working-with-collections.mdx`
yanthomasdev Sep 11, 2024
3575b26
yan vs `api-reference.mdx`
yanthomasdev Sep 11, 2024
26fea24
yan vs `loader-reference.mdx`
yanthomasdev Sep 11, 2024
4729b87
fix links
sarah11918 Sep 11, 2024
bea836d
initial move of all content on to content collections page
sarah11918 Sep 11, 2024
e4e0321
link fixes
sarah11918 Sep 11, 2024
dfbd7a7
fix last link!
sarah11918 Sep 11, 2024
6215cc0
move migrating collections steps to upgrade guide
sarah11918 Sep 11, 2024
2d868c6
adds tips to markdown page
sarah11918 Sep 12, 2024
714b6d4
[BETA] ci: update error reference docs (#9382)
astrobot-houston Sep 12, 2024
7e027a1
updated legacy, deprecated, removed section of upgrade guide
sarah11918 Sep 12, 2024
48c953a
update implementation PR titles
sarah11918 Sep 12, 2024
8bc5b62
upgrade guide: created a changed defaults section
sarah11918 Sep 12, 2024
7612c74
upgrade guide: some added and placeholder ReadMore components
sarah11918 Sep 12, 2024
81a1096
Merge branch 'main' into 5.0.0-beta
delucis Sep 12, 2024
eade5a7
Remove remaining references to Lit integration (#9386)
Fryuni Sep 12, 2024
f9d38ff
upgrade guide: fix some in-page links
sarah11918 Sep 12, 2024
87bc0d6
Merge branch '5.0.0-beta' of https://github.com/withastro/docs into 5…
sarah11918 Sep 12, 2024
d016af6
one more link
sarah11918 Sep 12, 2024
b8ff494
just another link fix
sarah11918 Sep 12, 2024
4ab9a84
Merge branch 'main' into 5.0.0-beta
sarah11918 Sep 12, 2024
f3221be
upgrade guide: update/organize more entries
sarah11918 Sep 12, 2024
9fd2224
upgrade guide: light edits
sarah11918 Sep 12, 2024
04ae42d
feat: injectRoute PR (#9388)
florian-lefebvre Sep 12, 2024
6ee6a0b
ViewTransitions change
matthewp Sep 12, 2024
ec94a5c
Server islands (#9255)
matthewp Sep 12, 2024
168718c
fix links
sarah11918 Sep 12, 2024
356cd53
Merge branch 'main' into 5.0.0-beta
sarah11918 Sep 13, 2024
e6500f9
feat: injectRoute PR (#9399)
florian-lefebvre Sep 13, 2024
5300202
extra mention of layout frontmatter property not being supported in c…
sarah11918 Sep 13, 2024
b41b72c
update content collections API reference
sarah11918 Sep 13, 2024
ca96d18
revert and standardize Since components in Content Layer API reference
sarah11918 Sep 13, 2024
7d07355
getEntry multiple types
sarah11918 Sep 13, 2024
497a9ac
Type for loader
ascorbic Sep 13, 2024
3280963
Rename ViewTransitions to ClientRouter (#9391)
matthewp Sep 13, 2024
0f2bf99
Merge branch 'main' into 5.0.0-beta
sarah11918 Sep 13, 2024
85c8d77
[BETA] ci: update reference docs (#9401)
astrobot-houston Sep 13, 2024
e80f16a
add quick links intro section
sarah11918 Sep 13, 2024
a334def
add section for Vite, and nav bar entry for upgrade guide
sarah11918 Sep 13, 2024
2eaf022
Add changes about locals
matthewp Sep 13, 2024
5c363d2
Explain app class change
matthewp Sep 13, 2024
c4af927
yan vs `v5.mdx`
yanthomasdev Sep 13, 2024
de66672
Breaking changes pass done! Final upgrade guide complete draft.
sarah11918 Sep 13, 2024
47d9e3c
update githubURL for config reference file
sarah11918 Sep 15, 2024
f0a1b04
consistent code example
sarah11918 Sep 15, 2024
ff83cc1
update page descriptions in basics section, remove old page
sarah11918 Sep 15, 2024
b96ad80
Merge branch 'main' into 5.0.0-beta
sarah11918 Sep 15, 2024
f788e6f
[BETA] ci: update reference docs (#9409)
astrobot-houston Sep 15, 2024
378fa55
[BETA] ci: update error reference docs (#9400)
astrobot-houston Sep 15, 2024
c5a7a3c
rename translated rendering-modes files to match English
sarah11918 Sep 15, 2024
1043f3a
Merge branch '5.0.0-beta' of https://github.com/withastro/docs into 5…
sarah11918 Sep 15, 2024
ced9562
temp update error message for links
sarah11918 Sep 15, 2024
5a85ecd
revert removing rendering modes and renaming translation files
sarah11918 Sep 15, 2024
6c6798d
updates re: async compiledContent, no squoosh support
sarah11918 Sep 15, 2024
c13a6c1
[BETA] ci: update error reference docs (#9416)
astrobot-houston Sep 15, 2024
5fa9cb5
Update github url for 5.0 (#9419)
TheOtterlord Sep 15, 2024
935eddb
[BETA] ci: update reference docs (#9420)
astrobot-houston Sep 15, 2024
8827a16
feat(next): overriden locals note (#9414)
florian-lefebvre Sep 16, 2024
55bf938
Yan suggestion
sarah11918 Sep 16, 2024
0ede0fc
Armand suggestion
sarah11918 Sep 16, 2024
bb49767
minor uprade guide polishing
sarah11918 Sep 16, 2024
ba061cc
Add v5 guide for PRs by Erika (#9404)
Princesseuh Sep 16, 2024
994ba75
content collections updates
sarah11918 Sep 16, 2024
cb8805e
update Actions input API
sarah11918 Sep 16, 2024
6c6eecb
update link to main docs
sarah11918 Sep 16, 2024
772040b
fix all hyphens in server-rendering
sarah11918 Sep 16, 2024
afd168d
code sample line highlighting
sarah11918 Sep 16, 2024
3f169ec
update some page descriptions
sarah11918 Sep 16, 2024
f68a676
Update typescript.mdx
florian-lefebvre Sep 17, 2024
9742563
Merge branch 'main' into 5.0.0-beta
delucis Sep 17, 2024
391ecce
Remove banners
TheOtterlord Sep 17, 2024
875bdc5
[BETA] ci: update reference docs (#9428)
astrobot-houston Sep 17, 2024
51f8372
update Astro.glob section and find-replace examples
sarah11918 Sep 17, 2024
e8bef24
update link, remove prompting message to do so
sarah11918 Sep 17, 2024
e0fc890
Merge branch 'main' into 5.0.0-beta
sarah11918 Sep 17, 2024
2d7bacf
fix(v5): format `adapter-reference.mdx` (#9423)
ArmandPhilippot Sep 17, 2024
db808bc
fix link
sarah11918 Sep 17, 2024
7693ed0
remove translations of 5.0 beta banner/tips
sarah11918 Sep 17, 2024
e5494d4
add create astro commands to upgrade guide
sarah11918 Sep 18, 2024
b3dea25
Fix beta docs editLink base url (#9441)
lorenzolewis Sep 18, 2024
26521cf
Fix typo & highlighting in beta upgrade guide (#9440)
lorenzolewis Sep 18, 2024
c52977c
Revert additional button on homepage
TheOtterlord Sep 20, 2024
4a29867
Merge branch 'main' into 5.0.0-beta
sarah11918 Sep 20, 2024
25e1e40
[BETA] ci: update error reference docs (#9455)
astrobot-houston Sep 20, 2024
ca7d812
enable pagefind (#9443)
lorenzolewis Sep 20, 2024
130e371
docs(en): update v5 migrate guide and container api reference (#9445)
xsynaptic Sep 23, 2024
534de83
feat: createCodegenDir (#9495)
florian-lefebvre Sep 26, 2024
dcd0d0f
feat: update upgrade guide (#9507)
florian-lefebvre Sep 30, 2024
7c66070
[BETA] ci: update reference docs (#9518)
astrobot-houston Oct 1, 2024
12d8dfd
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 2, 2024
ce89532
feat: document decoding of params (#9497)
ematipico Oct 3, 2024
afc9555
Updates on-demand-rendering.mdx (#9552)
JusticeMatthew Oct 3, 2024
ce185e4
Update content-collections-old.mdx
sarah11918 Oct 3, 2024
6483740
remove mention of removed CCC
sarah11918 Oct 3, 2024
6e32f93
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 3, 2024
8606cf8
[BETA] ci: update reference docs (#9549)
astrobot-houston Oct 3, 2024
59550ed
Update notes about vite 6 section
bluwy Oct 4, 2024
912034d
[BETA] ci: update reference docs (#9560)
astrobot-houston Oct 4, 2024
27fb5db
[BETA] ci: update error reference docs (#9559)
astrobot-houston Oct 4, 2024
bd5d3a5
[i18nIgnore] fix(5.0.0): update Vite links to use their new domain (#…
ArmandPhilippot Oct 4, 2024
7d0a46a
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 5, 2024
3942cdf
Reference dynamic route variables in Legacy Collection examples in v5…
cdvillard Oct 7, 2024
66c2029
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 7, 2024
600b4ca
update v5 upgrade guide for legacy collections
sarah11918 Oct 7, 2024
307db45
Merge branch '5.0.0-beta' of https://github.com/withastro/docs into 5…
sarah11918 Oct 7, 2024
0aeda8e
[BETA] ci: update reference docs (#9570)
astrobot-houston Oct 7, 2024
a9a07b5
fix link
sarah11918 Oct 7, 2024
9e0cbc9
Merge branch '5.0.0-beta' of https://github.com/withastro/docs into 5…
sarah11918 Oct 7, 2024
f7c2a8d
add docs for custom file formats in file content loader
sarah11918 Oct 7, 2024
6304f5a
upgrade guide: add SourcePR tags to legacy collections entries
sarah11918 Oct 8, 2024
92f8ba7
fix: remove outdated content folder info (#9596)
ascorbic Oct 8, 2024
63bd622
rename Loader API to Content Loader API
sarah11918 Oct 8, 2024
ee8bd09
Merge branch '5.0.0-beta' of https://github.com/withastro/docs into 5…
sarah11918 Oct 8, 2024
cff48a5
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 8, 2024
d9ac286
fix header for links
sarah11918 Oct 8, 2024
2e567e6
[BETA] ci: update reference docs (#9645)
astrobot-houston Oct 11, 2024
b5084f4
update on-demand rendering content
sarah11918 Oct 12, 2024
522ffb3
Merge branch '5.0.0-beta' of https://github.com/withastro/docs into 5…
sarah11918 Oct 12, 2024
00bc5b7
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 12, 2024
651c514
add missing component to on-demand rendered
sarah11918 Oct 12, 2024
3e82854
fix links based on changed headings
sarah11918 Oct 12, 2024
c63e90b
better heading
sarah11918 Oct 12, 2024
bbe5985
update all rendering links to new single on-demand rendering page
sarah11918 Oct 12, 2024
6ce353e
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 12, 2024
b2fdcac
fix typo
sarah11918 Oct 13, 2024
5ab5084
[BETA] ci: update reference docs (#9669)
astrobot-houston Oct 14, 2024
daac853
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 14, 2024
03030f1
delete old-translations folder and update redirects
sarah11918 Oct 14, 2024
b788efe
Remove start command (#9646)
TheOtterlord Oct 15, 2024
f54349c
Merge branch 'main' into 5.0.0-beta
delucis Oct 15, 2024
e984433
feat: document new entrypoints (#9680)
ematipico Oct 15, 2024
534fe7c
Adam prendergast patch 1 (#9694)
AdamPrendergast Oct 16, 2024
5985401
fix(5.0.0): nitpicking and suggestions regarding `on-demand-rendering…
ArmandPhilippot Oct 16, 2024
015c5db
Fix typo (#9715)
kuldar Oct 17, 2024
c2124bc
Merge branch 'main' into 5.0.0-beta
delucis Oct 19, 2024
638104b
Fix incorrect prop destructuring in tutorial (#9751)
yusifsalam Oct 21, 2024
afbf7c0
feat(next): tweak i18n (#9756)
florian-lefebvre Oct 22, 2024
1a9ae34
[BETA] ci: update error reference docs (#9767)
astrobot-houston Oct 22, 2024
e16b0f2
[BETA] ci: update reference docs (#9768)
astrobot-houston Oct 22, 2024
8a4d413
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 22, 2024
697f7ef
Fix loader example in content-loader-reference (#9777)
Because789 Oct 23, 2024
781333d
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 23, 2024
8bd4759
fix link
sarah11918 Oct 23, 2024
d45589f
remove broken link
sarah11918 Oct 24, 2024
018c559
Merge branch 'main' into 5.0.0-beta
sarah11918 Oct 25, 2024
d6ecad9
add modules page for astro:env
sarah11918 Oct 25, 2024
1b637ca
fix some links, add 5.0 api-reference changes back in
sarah11918 Oct 25, 2024
0b242d3
fix more links
sarah11918 Oct 25, 2024
01d5049
Update add-content-collections.mdx (#9853)
TobeyWelch Oct 28, 2024
850deda
Merge branch 'main' into 5.0.0-beta
delucis Oct 30, 2024
d05ee7c
Add charset note md/mdx pages (#9757)
bluwy Oct 31, 2024
8184870
Document custom mode support (#9641)
bluwy Oct 31, 2024
fa98f83
feat: update Vercel imports (#9755)
ematipico Oct 31, 2024
3a208b1
fix link
sarah11918 Nov 1, 2024
0535812
update new transitions module page for ClientRouter
sarah11918 Nov 1, 2024
0900561
fix(v5): add missing import in content collection tutorial (#9950)
ArmandPhilippot Nov 11, 2024
f04e4ba
Merge branch 'main' into 5.0.0-beta
sarah11918 Nov 11, 2024
769056e
Merge branch 'main' into 5.0.0-beta
sarah11918 Nov 11, 2024
403aa7b
delete pl content guide to match English
sarah11918 Nov 11, 2024
b8dfb0c
fix links after merging in main
sarah11918 Nov 11, 2024
b3415c8
fix more links
sarah11918 Nov 11, 2024
d8c2ff9
last fix again
sarah11918 Nov 11, 2024
6245c70
Add 5.0 Actions Middleware change (#9943)
bholmesdev Nov 11, 2024
75f20c9
Revert "Add 5.0 Actions Middleware change (#9943)" (#9975)
TheOtterlord Nov 11, 2024
e4bbf97
[BETA] ci: update error reference docs (#9993)
astrobot-houston Nov 12, 2024
53b8038
typo fix
sarah11918 Nov 12, 2024
8f08548
Actions middleware (#9976)
TheOtterlord Nov 13, 2024
4d83700
Merge branch 'main' into 5.0.0-beta
sarah11918 Nov 13, 2024
a88eaed
Merge branch 'main' into 5.0.0-beta
delucis Nov 13, 2024
2e97957
Merge branch 'main' into 5.0.0-beta
sarah11918 Nov 15, 2024
e31eb5c
fix hook name typo
HiDeoo Nov 15, 2024
239849f
new programmatic-reference page (#10032)
sarah11918 Nov 17, 2024
a970786
Merge branch 'main' into 5.0.0-beta
delucis Nov 18, 2024
7ee2090
Merge branch 'main' into 5.0.0-beta
delucis Nov 18, 2024
d725d71
fix links from new programmatic API
sarah11918 Nov 18, 2024
9963742
remove View Transitions extend tutorial (#10033)
sarah11918 Nov 18, 2024
234ca29
Merge branch 'main' into 5.0.0-beta
yanthomasdev Nov 18, 2024
55fd46e
Merge branch 'main' into 5.0.0-beta
delucis Nov 19, 2024
3ea043a
Merge branch 'main' into 5.0.0-beta
delucis Nov 19, 2024
fc5c577
Implement tabbed sidebars (#9890)
delucis Nov 19, 2024
1f25d05
Fix incorrect reference in `mdx.mdx` file (#10065)
apatel369 Nov 20, 2024
47e0381
create new sidebar section for feature flags (#10058)
sarah11918 Nov 20, 2024
bdc26ee
Add `svg` component reference (#9911)
natemoo-re Nov 21, 2024
7b7ab74
Move content config file (#10061)
ascorbic Nov 21, 2024
2eb5e0d
[BETA] ci: update reference docs (#9994)
astrobot-houston Nov 21, 2024
c6864f6
update v5 guide with new experimental and legacy links
sarah11918 Nov 21, 2024
8656c4c
fix link
sarah11918 Nov 21, 2024
6466c12
[BETA] ci: update error reference docs (#10086)
astrobot-houston Nov 21, 2024
8b1e5c9
add responsive images as an experimental flag page (#10079)
sarah11918 Nov 21, 2024
b082c9c
content collections tutorial (#10035)
sarah11918 Nov 21, 2024
5cb38ee
streamlined install plus develop and build pages (#10060)
sarah11918 Nov 21, 2024
63e970f
Merge branch 'main' into 5.0.0-beta
sarah11918 Nov 21, 2024
dc19993
fix: original content config location
HiDeoo Nov 22, 2024
a039e65
feat(next): routes resolved hook (#10077)
florian-lefebvre Nov 22, 2024
100568a
recipe restructuring (#10093)
sarah11918 Nov 22, 2024
c5255e2
add pages missing in the sidebar
sarah11918 Nov 22, 2024
105d0e1
move rss to recipes in all languages and update links
sarah11918 Nov 22, 2024
c521b19
Update error linkget-static-paths-removed-rsshelper.mdx
sarah11918 Nov 22, 2024
f2b625e
one unified on-demand rendering page (#10095)
sarah11918 Nov 22, 2024
d52b426
shorter tip, U.S. spelling
sarah11918 Nov 22, 2024
3553820
update broken external X link
sarah11918 Nov 22, 2024
eb97806
Merge branch 'main' into 5.0.0-beta
sarah11918 Nov 22, 2024
d4f45a1
fix broken external link to X
sarah11918 Nov 22, 2024
fb8c277
fix de links
sarah11918 Nov 22, 2024
ebdf26b
[BETA] ci: update reference docs (#10091)
astrobot-houston Nov 25, 2024
900d35b
removed Node version guidance from upgrade guide as it hasn't changed
sarah11918 Nov 25, 2024
94e9051
Merge branch '5.0.0-beta' of https://github.com/withastro/docs into 5…
sarah11918 Nov 25, 2024
cf5a3c1
Fix action redirect reference (#10097)
bholmesdev Nov 25, 2024
553478c
[BETA] ci: update error reference docs (#10099)
astrobot-houston Nov 25, 2024
0315d8f
update vite 6 section
bluwy Nov 27, 2024
6be9473
update external true behaviour
bluwy Nov 27, 2024
621916c
Add content collection custom IDs section (#10109)
HiDeoo Nov 27, 2024
e6c5666
updates for IDX content (#10107)
sarah11918 Nov 27, 2024
4f46f99
Merge branch 'main' into 5.0.0-beta
sarah11918 Nov 27, 2024
1307918
remove one errant mention of 'hybrid' mode
sarah11918 Nov 29, 2024
fae1485
Merge remote-tracking branch 'origin/main' into 5.0.0-beta
sarah11918 Nov 30, 2024
377aa60
fix(v5): broken link and missing type annotations in tutorial (#10119)
ArmandPhilippot Nov 30, 2024
ae619d9
fix: make tutorial consistent with `blog-tutorial-demo` (Typescript e…
ArmandPhilippot Nov 30, 2024
af8245b
update link in error message
sarah11918 Nov 30, 2024
a22ed78
update link in error message
sarah11918 Nov 30, 2024
a072e25
fix link
sarah11918 Dec 1, 2024
da7caf9
fix link
sarah11918 Dec 1, 2024
fda65ef
fix: close gate actions middleware code block (#10124)
rvanlaarhoven Dec 1, 2024
879cd15
update some SSR wording (#10127)
sarah11918 Dec 2, 2024
2afb32c
Runtime API restructure (#10062)
sarah11918 Dec 2, 2024
aace426
redraft configuring Astro (#10063)
sarah11918 Dec 2, 2024
f2859de
Clean up v5 sidebar implementation (#10131)
delucis Dec 2, 2024
3ea0a8c
Merge branch 'main' into 5.0.0-beta
delucis Dec 2, 2024
f8e7349
minor text updates
sarah11918 Dec 3, 2024
dde3dfa
reverse upgrade guide order, env fix
sarah11918 Dec 3, 2024
ec73959
Remove / redirect added in 8b2b3eb
delucis Dec 3, 2024
8c9ec32
Remove v5 beta badge in site header added in 8e56929
delucis Dec 3, 2024
5ae75e9
Revert editLink change made in b3dea25
delucis Dec 3, 2024
beeff8d
Disable Pagefind and enable the `Search` component override changed i…
delucis Dec 3, 2024
32cd164
[upgrade guide] remove mentions of beta (#10121)
sarah11918 Dec 3, 2024
c6ea374
Clean up introduction to upgrade guide
delucis Dec 3, 2024
8a19c3f
Add link to v5 upgrade guide in banner to key pages
delucis Dec 3, 2024
44fede1
Tweak sidebar labelling
delucis Dec 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion scripts/docgen.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export async function run() {
const inputBuffer =
STUB ||
(await fetch(
`https://raw.githubusercontent.com/${sourceRepo}/${sourceBranch}/packages/astro/src/%40types/astro.ts`
`https://raw.githubusercontent.com/${sourceRepo}/${sourceBranch}/packages/astro/src/types/public/config.ts`
).then((r) => r.text()));

console.timeEnd(task);
Expand Down
2 changes: 2 additions & 0 deletions src/components/starlight/SiteTitle.astro
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import logo from '~/assets/astro-logo.svg?raw';
import docs from '~/assets/docs.svg?raw';
import type { Props } from '@astrojs/starlight/props';
import Badge from '../Badge.astro';

const main = 'https://astro.build/';
const self = '/' + (Astro.props.locale || 'en') + '/getting-started/';
Expand All @@ -10,6 +11,7 @@ const self = '/' + (Astro.props.locale || 'en') + '/getting-started/';
<span class="site-title sl-flex">
<a class="astro-logo" href={main} set:html={logo} aria-label="Astro" />
<a class="docs-logo" href={self} set:html={docs} aria-label="Docs" />
<Badge text="v5-beta" style={{alignSelf: 'center'}} />
</span>

<style>
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/en/concepts/why-astro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ i18nReady: true
Some highlights include:

- **[Islands](/en/concepts/islands/):** A component-based web architecture optimized for content-driven websites.
- **[UI-agnostic](/en/guides/framework-components/):** Supports React, Preact, Svelte, Vue, Solid, Lit, HTMX, web components, and more.
- **[UI-agnostic](/en/guides/framework-components/):** Supports React, Preact, Svelte, Vue, Solid, HTMX, web components, and more.
- **[Server-first](/en/basics/rendering-modes/):** Moves expensive rendering off of your visitors' devices.
- **[Zero JS, by default](/en/basics/astro-components/):** Less client-side JavaScript to slow your site down.
- **[Content collections](/en/guides/content-collections/):** Organize, validate, and provide TypeScript type-safety for your Markdown content.
Expand Down Expand Up @@ -73,7 +73,7 @@ An Astro website can [load 40% faster with 90% less JavaScript](https://twitter.

The `.astro` UI language is a superset of HTML: any valid HTML is valid Astro templating syntax! So, if you can write HTML, you can write Astro components! But, it also combines some of our favorite features borrowed from other component languages like JSX expressions (React) and CSS scoping by default (Svelte and Vue). This closeness to HTML also makes it easier to use progressive enhancement and common accessibility patterns without any overhead.

We then made sure that you could also use your favorite UI component languages that you already know, and even reuse components you might already have. React, Preact, Svelte, Vue, Solid, Lit, and others, including web components, are all supported for authoring UI components in an Astro project.
We then made sure that you could also use your favorite UI component languages that you already know, and even reuse components you might already have. React, Preact, Svelte, Vue, Solid, and others, including web components, are all supported for authoring UI components in an Astro project.

Astro was designed to be less complex than other UI frameworks and languages. One big reason for this is that Astro was designed to render on the server, not in the browser. That means that you don't need to worry about: hooks (React), stale closures (also React), refs (Vue), observables (Svelte), atoms, selectors, reactions, or derivations. There is no reactivity on the server, so all of that complexity melts away.

Expand Down
4 changes: 4 additions & 0 deletions src/content/docs/en/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ hero:
icon: right-arrow
variant: minimal
link: /en/concepts/why-astro/
- text: V5 UPGRADE GUIDE - delete before publishing
icon: rocket
link: /en/guides/upgrade-to/v5/
variant: primary
facepile:
tagline: Powered by Astro and our open-source contributors.
linkText: Join us!
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/en/guides/framework-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Build your Astro website without sacrificing your favorite component framework.

## Official UI Framework Integrations

Astro supports a variety of popular frameworks including [React](https://react.dev/), [Preact](https://preactjs.com/), [Svelte](https://svelte.dev/), [Vue](https://vuejs.org/), [SolidJS](https://www.solidjs.com/), [AlpineJS](https://alpinejs.dev/) and [Lit](https://lit.dev/) with official integrations.
Astro supports a variety of popular frameworks including [React](https://react.dev/), [Preact](https://preactjs.com/), [Svelte](https://svelte.dev/), [Vue](https://vuejs.org/), [SolidJS](https://www.solidjs.com/), and [AlpineJS](https://alpinejs.dev/) with official integrations.

Find even more [community-maintained framework integrations](https://astro.build/integrations/?search=&categories%5B%5D=frameworks) (e.g. Angular, Qwik, Elm) in our integrations directory.

Expand Down
216 changes: 10 additions & 206 deletions src/content/docs/en/guides/integrations-guide/lit.mdx
Original file line number Diff line number Diff line change
@@ -1,218 +1,22 @@
---
type: integration
title: '@astrojs/lit'
description: Learn how to use the @astrojs/lit framework integration to extend component support in your Astro project.
githubIntegrationURL: 'https://github.com/withastro/astro/tree/main/packages/integrations/lit/'
category: renderer
title: 'Lit'
description: Using Lit to extend component support in your Astro project.
i18nReady: true
---
import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro'

This **[Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [Lit](https://lit.dev/) custom elements.

## Installation

Astro includes an `astro add` command to automate the setup of official integrations. If you prefer, you can [install integrations manually](#manual-install) instead.

To install `@astrojs/lit`, run the following from your project directory and follow the prompts:

<PackageManagerTabs>
<Fragment slot="npm">
```sh
npx astro add lit
```
</Fragment>
<Fragment slot="pnpm">
```sh
pnpm astro add lit
```
</Fragment>
<Fragment slot="yarn">
```sh
yarn astro add lit
```
</Fragment>
</PackageManagerTabs>

If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below.

### Manual Install

First, install the `@astrojs/lit` package:

<PackageManagerTabs>
<Fragment slot="npm">
```sh
npm install @astrojs/lit
```
</Fragment>
<Fragment slot="pnpm">
```sh
pnpm add @astrojs/lit
```
</Fragment>
<Fragment slot="yarn">
```sh
yarn add @astrojs/lit
```
</Fragment>
</PackageManagerTabs>

Most package managers will install associated peer dependencies as well. If you see a "Cannot find package 'lit'" (or similar) warning when you start up Astro, you'll need to install `lit` and `@webcomponents/template-shadowroot`:

<PackageManagerTabs>
<Fragment slot="npm">
```sh
npm install lit @webcomponents/template-shadowroot
```
</Fragment>
<Fragment slot="pnpm">
```sh
pnpm add lit @webcomponents/template-shadowroot
```
</Fragment>
<Fragment slot="yarn">
```sh
yarn add lit @webcomponents/template-shadowroot
```
</Fragment>
</PackageManagerTabs>

Then, apply the integration to your `astro.config.*` file using the `integrations` property:

```js ins={2} ins="lit()" title="astro.config.mjs"
import { defineConfig } from 'astro/config';
import lit from '@astrojs/lit';

export default defineConfig({
// ...
integrations: [lit()],
});
```

## Getting started

To use your first Lit component in Astro, head to our [UI framework documentation][astro-ui-frameworks]. This explains:

* 📦 how framework components are loaded,
* 💧 client-side hydration options, and
* 🤝 opportunities to mix and nest frameworks together

Writing and importing a Lit component in Astro looks like this:

```js title="src/components/my-element.js"
import { LitElement, html } from 'lit';

export class MyElement extends LitElement {
render() {
return html`<p>Hello world! From my-element</p>`;
}
}

customElements.define('my-element', MyElement);
```

Now, the component is ready to be imported via the Astro frontmatter:

```astro title="src/pages/index.astro"
---
import { MyElement } from '../components/my-element.js';
---

<MyElement />
```

:::note
Lit requires browser globals such as `HTMLElement` and `customElements` to be present. For this reason the Lit renderer shims the server with these globals so Lit can run. You *might* run into libraries that work incorrectly because of this.
:::caution[Deprecated]
This Astro integration to enable server-side rendering and client-side hydration for your [Lit](https://lit.dev/) custom elements was deprecated in Astro 5.0.
:::

### Experimental Decorators

To use [experimental decorators in Lit](https://lit.dev/docs/components/decorators/), add the following to your `tsconfig.json` file:

```json title="tsconfig.json" add={3}
{
"compilerOptions": {
"experimentalDecorators": true,
}
}
```

This allows you to use experimental decorators such as `@customElement` and `@state` to register a custom element and define a state property in your Lit component:

```ts title="src/components/my-element.ts"
import { LitElement, html } from "lit";
import { customElement, state } from "lit/decorators.js";

@customElement("my-element")
export class MyElement extends LitElement {
@state() name = "my-element";

override render() {
return html`<p>Hello world! From ${this.name}</p>`;
}
}
```

### Polyfills & Hydration

The renderer automatically handles adding appropriate polyfills for support in browsers that don't have Declarative Shadow DOM. The polyfill is about *1.5kB*. If the browser does support Declarative Shadow DOM then less than 250 bytes are loaded (to feature detect support).

Hydration is also handled automatically. You can use the same hydration directives such as `client:load`, `client:idle` and `client:visible` as you can with other libraries that Astro supports.
You can continue to use Lit for client components by adding a client-side script tag. For example:

```astro
---
import { MyElement } from '../components/my-element.js';
---
<script>
import "../components/MyTabs";
</script>

<MyElement client:visible />
<my-tabs title="These are my tabs">...</my-tabs>
```

The above will only load the element's JavaScript when the user has scrolled it into view. Since it is server rendered they will not see any jank; it will load and hydrate transparently.

## Troubleshooting

For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!

You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.

Common issues are listed below:

### Browser globals

The Lit integration's SSR works by adding a few browser global properties to the global environment. Some of the properties it adds includes `window`, `document`, and `location`.

These globals *can* interfere with other libraries that might use the existence of these variables to detect that they are running in the browser, when they are actually running in the server. This can cause bugs with these libraries.

Because of this, the Lit integration might not be compatible with these types of libraries. One thing that can help is changing the order of integrations when Lit is interfering with other integrations:

```js lang="js" title="astro.config.mjs" ins={7} del={6}
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
import lit from '@astrojs/lit';

export default defineConfig({
integrations: [vue(), lit()]
integrations: [lit(), vue()]
});
```

The correct order might be different depending on the underlying cause of the problem. This is not guaranteed to fix every issue however, and some libraries cannot be used if you are using the Lit integration because of this.

### Strict package managers

When using a [strict package manager](https://pnpm.io/pnpm-vs-npm#npms-flat-tree) like `pnpm`, you may get an error such as `ReferenceError: module is not defined` when running your site. To fix this, hoist Lit dependencies with an `.npmrc` file:

```ini title=".npmrc"
public-hoist-pattern[]=*lit*
```

### Limitations

- The Lit integration is powered by `@lit-labs/ssr` which has some limitations. See their [limitations documentation](https://www.npmjs.com/package/@lit-labs/ssr#notes-and-limitations) to learn more.

- Astro does not support IntelliSense for Lit components.

[astro-integration]: /en/guides/integrations-guide/

[astro-ui-frameworks]: /en/guides/framework-components/#using-framework-components
If you're interested in maintaining a Lit integration yourself, you may wish to use the [last published version of `@astrojs/lit`](https://github.com/withastro/astro/tree/astro%404.13.0/packages/integrations/lit) as a starting point and upgrade the relevant packages.
27 changes: 0 additions & 27 deletions src/content/docs/en/guides/integrations-guide/vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -374,33 +374,6 @@ export default defineConfig({
});
```

### Function bundling configuration

:::caution[Deprecated]
The `functionPerRoute` option is deprecated and will be removed entirely in Astro 5. Additionally, this option is incompatible with some Astro features such as i18n domains and request rewriting.

If you have currently enabled `functionPerRoute: true`, we recommend removing this configuration option as soon as you are able.
:::

The Vercel adapter combines all of your routes into a single function by default.

You also have the option to split builds into a separate function for each route using the `functionPerRoute` option. This reduces the size of each function, meaning you are less likely to exceed the size limit for an individual function. Also, code starts are faster.

Verify that your Vercel plan includes an appropriate number of functions before enabling `functionPerRoute`. For example, Vercel's free tier limits each deployment to no more than 12 functions. If your Vercel plan is insufficient for the number of routes in your project, you will receive an error message during deployment.

```js title="astro.config.mjs" ins={8}
import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
// ...
output: 'server',
adapter: vercel({
functionPerRoute: true,
}),
});
```

### Running Astro middleware on Vercel Edge Functions

The `@astrojs/vercel/serverless` adapter can create an [edge function](https://vercel.com/docs/functions/edge-functions) from an Astro middleware in your code base. When `edgeMiddleware` is enabled, an edge function will execute your middleware code for all requests including static assets, prerendered pages, and on-demand rendered pages.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/en/guides/internationalization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ This feature has some restrictions:
- The `site` option is mandatory.
- The `output` option must be set to `"server"`.
- There cannot be any individual prerendered pages.
- The adapter feature [`functionPerRoute`](/en/reference/adapter-reference/#functionperroute) is not supported.


Astro relies on the following headers in order to support the feature:
- [`X-Forwarded-Host`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host) and [`Host`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Host). Astro will use the former, and if not present, will try the latter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Docusaurus and Astro share some similarities that will help you migrate your pro

When you rebuild your Docusaurus site in Astro, you will notice some important differences:

- Docusaurus is a React-based single-page application (SPA). Astro sites are multi-page apps built using [`.astro` components](/en/basics/astro-components/), but can also support [React, Preact, Vue.js, Svelte, SolidJS, AlpineJS, Lit](/en/guides/framework-components/) and raw HTML templating.
- Docusaurus is a React-based single-page application (SPA). Astro sites are multi-page apps built using [`.astro` components](/en/basics/astro-components/), but can also support [React, Preact, Vue.js, Svelte, SolidJS, AlpineJS](/en/guides/framework-components/) and raw HTML templating.

- Docusaurus was designed to build documentation websites and has some built-in, documentation-specific website features that you would have to build yourself in Astro. Instead, Astro offers some of these features through [Starlight: an official docs theme](https://starlight.astro.build). This website was the inspiration for Starlight, and now runs on it! You can also find more [community docs themes](https://astro.build/themes?search=&categories%5B%5D=docs) with built-in features in our Themes Showcase.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Gridsome and Astro share some similarities that will help you migrate your proje

When you rebuild your Gridsome site in Astro, you will notice some important differences:

- Gridsome is a Vue-based single-page application (SPA). Astro sites are multi-page apps built using [`.astro` components](/en/basics/astro-components/), but can also support [React, Preact, Vue.js, Svelte, SolidJS, AlpineJS, Lit](/en/guides/framework-components/) and raw HTML templating.
- Gridsome is a Vue-based single-page application (SPA). Astro sites are multi-page apps built using [`.astro` components](/en/basics/astro-components/), but can also support [React, Preact, Vue.js, Svelte, SolidJS, AlpineJS](/en/guides/framework-components/) and raw HTML templating.

- As an SPA, Gridsome uses `vue-router` for SPA routing, and `vue-meta` for managing `<head>`. In Astro, you will create separate HTML pages and control your page `<head>` directly, or in a [layout component](/en/basics/layouts/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Nuxt and Astro share some similarities that will help you migrate your project:

When you rebuild your Nuxt site in Astro, you will notice some important differences:

- Nuxt is a Vue-based SPA (single-page application). Astro sites are multi-page apps built using `.astro` components, but can also support React, Preact, Vue.js, Svelte, SolidJS, AlpineJS, Lit and raw HTML templating.
- Nuxt is a Vue-based SPA (single-page application). Astro sites are multi-page apps built using `.astro` components, but can also support React, Preact, Vue.js, Svelte, SolidJS, AlpineJS, and raw HTML templating.

- [Page Routing](/en/basics/astro-pages/#file-based-routing): Nuxt uses `vue-router` for SPA routing, and `vue-meta` for managing `<head>`. In Astro, you will create separate HTML page routes and control your page `<head>` directly, or in a layout component.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ When you rebuild your SvelteKit site in Astro, you will notice some important di

- Astro sites are multi-page apps, whereas SvelteKit defaults to SPAs (single-page applications) with server-side rendering, but can also create MPAs, traditional SPAs, or you can mix and match these techniques within an app.

- [Components](/en/basics/astro-components/): SvelteKit uses [Svelte](https://svelte.dev). Astro pages are built using [`.astro` components](/en/basics/astro-components/), but can also support [React, Preact, Vue.js, Svelte, SolidJS, AlpineJS, Lit](/en/guides/framework-components/) and raw HTML templating.
- [Components](/en/basics/astro-components/): SvelteKit uses [Svelte](https://svelte.dev). Astro pages are built using [`.astro` components](/en/basics/astro-components/), but can also support [React, Preact, Vue.js, Svelte, SolidJS, AlpineJS](/en/guides/framework-components/) and raw HTML templating.

- [content-driven](/en/concepts/why-astro/#content-driven): Astro was designed to showcase your content and to allow you to opt-in to interactivity only as needed. An existing SvelteKit app might be built for high client-side interactivity. Astro has built-in capabilities for working with your content, such as page generation, but may require advanced Astro techniques to include items that are more challenging to replicate using `.astro` components, such as dashboards.

Expand Down
Loading
Loading