2
2
3
3
## Introduction 👋
4
4
5
- Welcome to the repository for the EuroPython website! We use
6
- [ Astro ] ( https://astro.build ) in combination with pnpm to manage dependencies.
5
+ Welcome to the repository for the EuroPython website! We use [ Astro ] ( https://astro.build ) in
6
+ combination with pnpm to manage dependencies.
7
7
8
8
## Setup 🛠️
9
9
10
10
### Local dev env
11
11
12
- To get started, clone the repository and run ` pnpm install ` to fetch all the
13
- dependencies. Then, use ` pnpm run dev ` to start the development server.
12
+ To get started, clone the repository and run ` pnpm install ` to fetch all the dependencies. Then, use
13
+ ` pnpm run dev ` to start the development server.
14
14
15
15
The website will be available at ` http://localhost:4321 ` .
16
16
17
17
### Pre-commit Setup
18
18
19
- To ensure code quality and consistency, we use ` pre-commit ` hooks. Follow these
20
- steps to set up ` pre-commit ` on your local environment:
19
+ To ensure code quality and consistency, we use ` pre-commit ` hooks. Follow these steps to set up
20
+ ` pre-commit ` on your local environment:
21
21
22
22
1 . Install ` pre-commit ` . You can follow the instructions from
23
23
[ pre-commit.com] ( https://pre-commit.com/#install ) .
24
24
2 . Run ` pre-commit install ` in the root of your local repository.
25
- 3 . Now, ` pre-commit ` will run automatically on ` git commit ` . You can also run it
26
- manually on all files using ` pre-commit run --all-files ` .
25
+ 3 . Now, ` pre-commit ` will run automatically on ` git commit ` . You can also run it manually on all
26
+ files using ` pre-commit run --all-files ` .
27
27
28
- This will help maintain a consistent coding style and catch common issues before
29
- submission.
28
+ This will help maintain a consistent coding style and catch common issues before submission.
30
29
31
30
### Docker
32
31
@@ -41,25 +40,22 @@ The website will be available at `http://localhost:4321`.
41
40
42
41
## Content Structure 🗂️
43
42
44
- The content of the site is store in this repository. We are using Astro's
45
- content collections to manage the content. The collections are configure inside
46
- ` src/content/config.ts ` .
43
+ The content of the site is store in this repository. We are using Astro's content collections to
44
+ manage the content. The collections are configure inside ` src/content/config.ts ` .
47
45
48
46
### Pages
49
47
50
- Pages are stored in the ` src/content/pages ` directory. Each page is a mdx file
51
- with frontmatter.
48
+ Pages are stored in the ` src/content/pages ` directory. Each page is a mdx file with frontmatter.
52
49
53
50
### Deadlines
54
51
55
- Meanwhile, our important deadlines ⏰ are located inside the
56
- ` src/content/deadlines ` directory.
52
+ Meanwhile, our important deadlines ⏰ are located inside the ` src/content/deadlines ` directory.
57
53
58
54
## Using Astro Image Component 🖼️
59
55
60
- When adding images to the website, please make sure to use astro Image component
61
- and to specify the width of the image. This will make sure we are optimizing the
62
- images and not serving large images to the users.
56
+ When adding images to the website, please make sure to use astro Image component and to specify the
57
+ width of the image. This will make sure we are optimizing the images and not serving large images to
58
+ the users.
63
59
64
60
Here is an example:
65
61
@@ -68,5 +64,8 @@ import { Image } from "astro:assset";
68
64
69
65
import image from " ./image.jpg" ;
70
66
71
- < Image src= {image} width= {500 } / > ;
67
+ < Image
68
+ src= {image}
69
+ width= {500 }
70
+ / > ;
72
71
```
0 commit comments