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
Patternfly documentation core contains the base packages needed to build and release the PatternFly org website.
6
4
7
-
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
8
-
[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
9
-
[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
5
+
## Development
10
6
11
-
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
7
+
The website is built using [Astro](https://astro.build). Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
12
8
13
-
## 🚀 Project Structure
14
-
15
-
Inside of your Astro project, you'll see the following folders and files:
16
-
17
-
```text
18
-
/
19
-
├── public/
20
-
├── src/
21
-
│ └── pages/
22
-
│ └── index.astro
23
-
└── package.json
24
-
```
25
-
26
-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
27
-
28
-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
9
+
The `src/components/` folder contains Astro and React components that can be used to build the websites pages.
29
10
30
11
Any static assets, like images, can be placed in the `public/` directory.
31
12
13
+
To define the markdown schema this project uses a typescript based schema known as [Zod](https://zod.dev). Details of how this is integratred into Astro can be found in Astros documentation on [content creation using Zod](https://docs.astro.build/en/guides/content-collections/#defining-datatypes-with-zod).
14
+
32
15
## 🧞 Commands
33
16
34
17
All commands are run from the root of the project, from a terminal:
@@ -41,7 +24,3 @@ All commands are run from the root of the project, from a terminal:
41
24
|`npm run preview`| Preview your build locally, before deploying |
42
25
|`npm run astro ...`| Run CLI commands like `astro add`, `astro check`|
43
26
|`npm run astro -- --help`| Get help using the Astro CLI |
44
-
45
-
## 👀 Want to learn more?
46
-
47
-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
0 commit comments