You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update getExcerptOfPost function to be async
* Update RSS feed to use async compiledContent()
* Hack around Integrations change
* Remove debug logging from search integration
* Move to import.meta.glob() from Astro.glob()
Astro.glob() is deprecated in Astro 5
* Upgrade to Astro 5
* Add note about dev server encoding in Astro 5
* README updates
* Remove astro-purgecss
It doesn’t seem to support Astro 5
* Remove override for astro-purgecss
That was what was causing the issue all along.
* Fix README typo
Copy file name to clipboardExpand all lines: README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,12 @@ Website for the Quilt Project.
4
4
5
5
## Contributing
6
6
7
-
This site built with [Astro](https://astro.build), [MDX](https://mdxjs.com), and [i18next](https://www.i18next.com). It is hosted on [Cloudflare Pages](https://developers.cloudflare.com/pages/). If you want to get more familiar with Astro, you can read [its documentation](https://docs.astro.build).
7
+
This site is built with [Astro](https://astro.build), [MDX](https://mdxjs.com), and [i18next](https://www.i18next.com). It is hosted on [Cloudflare Pages](https://developers.cloudflare.com/pages/). If you want to get more familiar with Astro, you can read [its documentation](https://docs.astro.build). The following articles from the documentation explain how Astro works without being tutorials for anything specific:
-[Markdown](https://docs.astro.build/en/guides/markdown-content/) and [MDX](https://docs.astro.build/en/guides/integrations-guide/mdx/#usage)
8
13
9
14
If you get stuck or have questions, please join us in the [`#Website`](https://discord.com/channels/817576132726620200/1103986836415713300) thread on our [Discord server](https://discord.quiltmc.org).
10
15
@@ -19,7 +24,6 @@ If you would prefer not to use VSCode, you can use any editor that supports a su
19
24
- If you want to work with layouts or components, you need an editor with support for .astro files, such as:
20
25
- [Sublime Text](https://www.sublimetext.com) with the [Astro extension](https://packagecontrol.io/packages/Astro)
21
26
- [Neovim](https://neovim.io) with [tree-sitter-astro](https://github.com/virchau13/tree-sitter-astro) and the [Astro lspconfig](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#astro)
22
-
- JetBrains [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/) or [WebStorm](https://www.jetbrains.com/webstorm/) with the [Astro extension](https://plugins.jetbrains.com/plugin/20959-astro)
23
27
- If you want to work with more complex pages, you may want an editor with support for MDX, though many editors with Markdown support render MDX fairly accurately.
24
28
- If you want work with the i18n system, you may want an editor with support for [Fluent](https://projectfluent.org). However, this isn't strictly necessary if you only want to translate the website.
25
29
@@ -57,14 +61,17 @@ Astro includes a development server that automatically reloads itself as you cha
57
61
```
58
62
The dev server builds pages as you visit them to reduce start time, so its performance is worse than the fully built site.
59
63
64
+
> [!Note]
65
+
> In Astro 5, the dev server has introduced some strange encoding issues, like displaying apostrophes as "’". These issues do not appear in the finally built site.
66
+
60
67
#### Building the site
61
68
To build a full copy of the final site:
62
69
```
63
70
pnpm build
64
71
```
65
72
The site will be built into the `dist/` folder. Building the site is a useful way to check that you haven't broken anything without noticing.
66
73
67
-
You can preview the built site using `pnpm astro preview`, but in most cases the only advantage this has over the dev server is performance.
74
+
You can preview the built site using `pnpm astro preview`. This has similar performance to the production website, and avoids the strange encoding issues that the dev server seems to have.
68
75
69
76
### Previewing with Cloudflare Wrangler
70
77
If you need to test Cloudflare Pages-specific functionality (such as anything in the `functions/` directory), you can preview the site using Cloudflare's [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/)to emulate a Cloudflare Pages deployment.
@@ -113,7 +120,7 @@ Your entry must have the following fields:
113
120
-`"notes":` (optional) - Any other notes, for example, the a known workaround.
114
121
115
122
#### Writing a Blog Post
116
-
Create a new Markdown file in `src/pages/en/blog`, named with the current date and a shortened version of the title. The date should be in the format `yyyy-mm-dd`, and the title should be in lowercase and separated by hyphens (`-`), for example, `2024-03-09-example-post.md`.
123
+
Create a new Markdown file in `src/pages/en/blog`, named with the current date and a shortened version of the title. The date should be in the format `yyyy-mm-dd`, and the title should be in lowercase and separated by hyphens (`-`), for example, `2024-03-09-example-post.md`. The file *must* end with `.md` and *not*`.mdx`
117
124
118
125
At the top of the file, you need to add *front matter*, which is metadata written in YAML. The front matter for a blog post looks like this:
0 commit comments