0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
Commit graph

33 commits

Author SHA1 Message Date
Elian ☕️
ec249f7a98
update all the readme's for expressive code (#8691)
Co-authored-by: HiDeoo <HiDeoo@users.noreply.github.com>
Co-authored-by: Genteure <Genteure@users.noreply.github.com>
Co-authored-by: Bryce Russell <brycetrussell@gmail.com>
Co-authored-by: Reuben Tier <TheOtterlord@users.noreply.github.com>
Co-authored-by: Hippo <hippotastic@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Kevin Zuniga Cuellar <kevinzunigacuellar@users.noreply.github.com>
2023-09-28 15:48:03 +02:00
Martin Trapp
bee284cb77
docs: fix github search link in README.md (#8063)
Co-authored-by: Elian ️ <hello@elian.codes>
2023-08-14 11:22:13 +02:00
Marek Brzezinski
6a27e932d6
Added slashes at the end of the filter option in the sitemap docs (#7915)
I trend to implement the sitemap and I found out that filter option works only when the URL has slashes at the end. I changed the examples.

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2023-08-07 12:52:13 -05:00
Sarah Rainsberger
29162c99fb
[docs] @astrojs/sitemap README update (#7748) 2023-07-21 09:59:23 -03:00
Nate Moore
dd931a7806
Sitemap should only include page routes (#7656)
* fix(#7080): sitemap should only add trailing slash to pages

* fix(sitemap): only include pages in sitemap

* chore: add test

* chore: remove unused import

* docs: update readme
2023-07-17 15:29:56 -05:00
Matthew Phillips
795d598aeb
Revert "Clarify SSR limitations of sitemaps of dynamic routes (#7625)" (#7653)
This reverts commit 9352ac65f4.
2023-07-14 11:47:24 -04:00
matthewp
798442427d [ci] format 2023-07-14 14:58:18 +00:00
paulrudy
9352ac65f4
Clarify SSR limitations of sitemaps of dynamic routes (#7625)
While this README doesn't distinguish between SSR mode and static mode (and SSR mode was recently made available for the sitemaps integration), there is one important difference: Dynamic routes that are server-rendered can't be used to create sitemap entries.

This note makes that clear.
2023-07-14 10:56:03 -04:00
Hippo
bc9ce779d3
Move code block titles into comments to match docs (#7543)
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
2023-07-01 16:34:49 +02:00
Chris Swithinbank
2eca765f91
Remove invalid code block language tag in sitemap README (#7487) 2023-06-27 00:02:20 +02:00
Bjorn Lu
8e3cb20b5c
Format markdown files (#7439)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2023-06-26 11:34:13 +08:00
Tc001
67d3d1d65a
Replace tabs with double spaces (#6562) 2023-03-16 15:46:31 +02:00
Elian ☕️
1343a6469f
Get rid of ‘txt not found’ (#6486) 2023-03-09 16:28:21 +01:00
Tc001
28e1224d12
Add instructions on how to link the sitemap (#6448)
* Add instructions on how to link the sitemap

* Update packages/integrations/sitemap/README.md

Co-authored-by: Dan Jutan <danjutan@gmail.com>

---------

Co-authored-by: Dan Jutan <danjutan@gmail.com>
2023-03-07 20:45:36 +02:00
Subha Chanda
1c7eef308e
Updated according to new configuration (#5478)
* Updated according to new configuration

Astro imports the `defineConfig` function from `astro/config`. The `integrations` key needs to be passed into the `defineConfig` function, but it is not shown in the README. Updated the README according to the CLI example.

* update alpine

* update image

* update lit

* update mdx

* update preact

* update prefetch

* update react

* update sitemap

* update solid

* update svelte

* update tailwind

* update turbolinks

* update vue

* chore: add changeset

* update image

* update svelte readme

Co-authored-by: Nate Moore <nate@astro.build>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2023-01-26 13:03:00 -06:00
tweenietomatoes
649e9080cb
fixed typing (#4893) 2022-09-27 14:57:11 -03:00
Jake Strawn
b0f6216367
docs: Update references to support channel in Discord. (#4872) 2022-09-26 21:02:05 +08:00
Ben Holmes
c706d845eb
No 👏 more 👏 server 👏 restarts 👏 on 👏 config 👏 changes (#4578)
* feat: restart config on add, remove, update

* fix: reload for root project configs only

* fix: throw when userConfigPath can't resolve

* chore: changeset

* wip: remove normalizePath before writeFile

* refactor: invalidateWithCache -> isConfigReload

* wip: mustExist?

* debug: config loaded successfully

* debug: more logs

* debug: MORE logging

* fix: normalize resolved config path

* debug: yet MORE logging

* chore: bump proload

* fix: use file path, not URL.pathname

* Revert "wip: mustExist?"

This reverts commit 8ca8662132532dcdc9fd120868e615ddc60f498e.

* chore: remove console log

* feat: cleanup restart message, better invalid config handling

* chore: update lockfile

* chore: fix types

* fix: throw helpful error when config does not exist

* docs: remove "restart dev server" from integrations

* docs: make sure to restart -> try restarting

Co-authored-by: Nate Moore <nate@astro.build>
2022-09-09 11:58:16 -04:00
Tibor Schiemann
d693e365ca
Integrations: Fix NPM instructions to use npx astro add again (#4653)
* Fix install instructions to use `npx astro` again

* Replace joyful hiccups with regular issues :)
2022-09-07 12:08:58 +02:00
Adam
62d98e4af3
Update Filter Section (#4455)
Add brief explanation and example of filtering multiple pages.
2022-08-24 16:14:50 -04:00
Chris Swithinbank
e2b3f8a3f4
integrations: update recommended method for running astro add (#4340) 2022-08-16 10:31:14 +02:00
Sarah Rainsberger
9894b3dcde
remove details tags from integration READMEs (#4198) 2022-08-08 12:07:38 -05:00
Sarah Rainsberger
ef9c4152b2
[READMEs] removed "experimental" from astro add instructions (#4004) 2022-07-21 14:33:59 -03:00
Astroalex
b37d7078a0
minor: updating the README for @astrojs/sitemap@0.2.0 changes (#3978)
* fix: updating the README for `v0.2.0` changes

* Create chilled-cherries-decide.md

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2022-07-19 14:02:30 -05:00
Chris Swithinbank
bf5d1cc1e7
More integration README fixes (#3885)
* Integration README fixes

* More tweaks (mostly code backticks for filenames)

* Update changeset

* Few more tweaks

* Make sure code blocks all have a code language

* Use URLs of new docs pages for package homepage

* One more stray `<br>` 👢

* Standardise to `sh` instead of `shell`
2022-07-11 21:10:34 +02:00
Chris Swithinbank
1f9e4857ff
Integration README fixes (#3865)
* Remove stray XML tag in sitemap integration README

* Fix link errors

* Add changeset
2022-07-08 21:56:24 +02:00
Dan Jutan
8045c8ade1
Integration Docs Next Steps (#3677)
* sitemap readme skeleton + first sections

* Revert "sitemap readme skeleton + first sections"

This reverts commit cc55b312b6.

* sitemap readme skeleton + first sections

* remove canonicalURL option from sitemap

* add customPages option to readme

* sitemap examples

* partytown

* deno run command

* reference deno example

* node readme

* netlify & vercel readmes

* note that telemetry is installed

* telemetry is *enabled*, not installed

* Update packages/integrations/vercel/README.md

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

* Update packages/integrations/vercel/README.md

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

* readme -> README

* Update packages/integrations/deno/readme.md

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

* Update packages/integrations/deno/readme.md

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

* qualify they

* Update packages/integrations/sitemap/README.md

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

* Uppercase README names

* Update packages/integrations/partytown/README.md

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

* imports -> import typo

* update changeset

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2022-06-30 12:02:39 -04:00
Oleksii Tymoshenko
52f75369ef
feat: better behavior for 'undefined' return values from 'serialize… (#3723)
* feat: better behavior with 'undefined' return values after 'serialize' func

* build: changeset added
2022-06-27 13:02:00 -05:00
Ben Holmes
3f8ee70e2b
Fix: document sitemap + SSR use case (#3689)
* fix: offer suggestion for SSR sitemap users

* docs: add customPages to README

* chore: changeset
2022-06-23 11:31:54 -04:00
Oleksii Tymoshenko
facfc4682f
refactor: better typings (#3634) 2022-06-20 14:29:53 -05:00
Oleksii Tymoshenko
1031c06f9c
feat: improved sitemap (#3579)
* feat: extended sitemap functionality

* docs: del samples

* docs: readme

* feat: new sitemap

* feat: createLinkInHead removed

* docs: updated changeset text

* refactor: 'zod' function() instead of self made refine()

* Revert "refactor: 'zod' function() instead of self made refine()"

This reverts commit 036bac730d.

undo function()
2022-06-16 19:06:48 +00:00
Nate Moore
17c02925c5
Migrate to new config (#2962)
* wip: config migration

* fix: formatting

* refactor: projectRoot -> root

* refactor: pageUrlFormat -> format

* refactor: buildOptions.site -> site

* refactor: public -> publicDir

* refactor: dist -> outDir

* refactor: styleOptions -> style

* fix: some dist tests -> outDir

* refactor: remove legacyBuild (with TODOs)

* refactor: more legacyBuild cleanup

* refactor: server host and port

* fix: remove experimentalStaticBuild CLI flag

* refactor: src -> srcDir

* refactor: devOptions.trailing -> trailing

* refactor: remove sitemap + related flags

* refactor: experimentalSSR -> experimental.ssr

* fix: last devOptions

* refactor: drafts -> markdown.drafts

* fix: TS error on port as const

* refactor: remove pages

* refactor: more --project-root updates

* refactor: markdownOptions -> markdown

* fix: remaining type errors

* feat: update AstroUserConfig

* refactor: update CLI flag mapper + server mapper

* fix: loadFixture projectRoot

* fix: merge CLI flags before validating / transforming

* wip: attempt to fix bad createRouteManifest config

* refactor: combine config.base and config.site

* fix: skip route manifest test for now

* fix: site and base handling

* refactor: update failing config testes

* fix: build failure

* feat: update config types with migration help

* chore: update types

* fix(deno): update deno fixture

* chore: remove config migration logic

* chore: remove logLevel

* chore: clean-up config types

* chore: update config warning

* chore: add changeset

* Sitemap Integration (#2965)

* feat: add sitemap filter config option

* feat: add canonicalURL sitemap config option

* docs: update sitemap README

* fix: update for new config

* fix: filter not being applied

* chore: changeset

Co-authored-by: bholmesdev <hey@bholmes.dev>

* fred pass

* fix: Astro.resolve typo

* fix: public => publicDir

Co-authored-by: bholmesdev <hey@bholmes.dev>
Co-authored-by: Fred K. Schott <fkschott@gmail.com>
2022-04-02 12:29:59 -06:00
Ben Holmes
6b004363f9
Docs: remaining integration READMEs (#2885)
* docs: partytown README

* docs: sitemap README

* docs: tailwind README

* docs: turbolinks README

* chore: changeset

* update: make partytown 10% less fun

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>

* docs: add summaries for each integration

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2022-03-25 17:45:34 -04:00