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
docs: cleanup readme and use standard conventions (#1844)
- Local dev setup guide is now a numbered list, and uses fences instead of dollar signs (fixes MD014)
- The "Please note" for next.config now uses the GFM note block
- Added actual alt text to screenshots, instead of just "Screenshot date"
- Removed plausible link that leads to a 404
Copy file name to clipboardExpand all lines: README.md
+20-13Lines changed: 20 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,28 @@
4
4
5
5
Hack Club's new website. This codebase is what runs on [hackclub.com](https://hackclub.com). For new developers getting started, run the following in your terminal:
6
6
7
-
Download the code to your computer:
7
+
1.Download the code to your computer:
8
8
9
-
$ git clone https://github.com/hackclub/site && cd site
9
+
```bash
10
+
git clone https://github.com/hackclub/site &&cd site
11
+
```
10
12
11
-
Install dependencies:
13
+
2. Install dependencies:
12
14
13
-
$ yarn
15
+
```bash
16
+
yarn
17
+
```
14
18
15
-
Start running the website on your computer:
19
+
3. Start running the website on your computer:
16
20
17
-
$ yarn dev
21
+
```bash
22
+
yarn dev
23
+
```
18
24
19
-
And then open up your web browser and go to [localhost:3000](http://localhost:3000).
25
+
4. Open up your web browser and go to [localhost:3000](http://localhost:3000)
20
26
21
-
Please note: There are a number of redirects and rewrites essential to the website's functionality, which you can see in [next.config.mjs](./next.config.mjs).
27
+
> [!NOTE]
28
+
> There are a number of redirects and rewrites essential to the website's functionality, which you can see in [next.config.mjs](./next.config.mjs).
22
29
23
30
Powered by [Next.js] with [MDX], [Theme UI], & [Hack Club Theme].
24
31
@@ -35,11 +42,11 @@ See something that could be better? Make a PR! Have an easter egg idea? Make a P
35
42
If you need to add content to the site, here's how you can:
36
43
37
44
<details> <summary>Create a new card</summary>
38
-
<imgwidth="600"alt="Screenshot 2023-08-16 at 9 09 55 PM"src="https://github.com/hackclub/site/assets/65808924/fed45800-c834-4e4c-ad87-a21e01414fa9">
45
+
<img width="600" alt="Screenshot of the Sprig card" src="https://github.com/hackclub/site/assets/65808924/fed45800-c834-4e4c-ad87-a21e01414fa9">
39
46
40
47
Most things on the homepage are cards, modular components that can easily be added and removed according to relevancy to Hack Clubbers. There are 3 main sections: connection, open-source, and IRL community. Most new cards will likely fall within the first two sections!
41
48
42
-
First, you can create a new file under [components/index/cards](components/index/cards/) with the name of your new event/project. Next add `import CardModel from './card-model'` and add whatever you want :) Finally, use a <Buttons> component (`import Buttons from './button'`) to highlight call-to-action buttons. If it's the main button, use the primary prop to add a background color!
49
+
First, you can create a new file under [components/index/cards](components/index/cards/) with the name of your new event/project. Next add `import CardModel from './card-model'` and add whatever you want :) Finally, use a `<Buttons>` component (`import Buttons from './button'`) to highlight call-to-action buttons. If it's the main button, use the primary prop to add a background color!
43
50
44
51
Your challenge: try and make the card as unique as possible, like a mini poster! Not sure where to start? Look at other cards on the page :)
45
52
@@ -48,7 +55,7 @@ Your challenge: try and make the card as unique as possible, like a mini poster!
48
55
<details>
49
56
<summary>Add to the carousel</summary>
50
57
51
-
<imgwidth="600"alt="Screenshot 2023-08-16 at 9 09 11 PM"src="https://github.com/hackclub/site/assets/65808924/044660eb-fb3d-43b6-a270-64a3fe51f3ca">
58
+
<img width="600" alt="Screenshot of a carousel section" src="https://github.com/hackclub/site/assets/65808924/044660eb-fb3d-43b6-a270-64a3fe51f3ca">
52
59
53
60
If there's a Hack Club or Hack Club community-led project (past or present) that Hack Clubbers can get involved in, please add it to [lib/carousel.json](lib/carousel.json) and add your card to the end of the json file. An example looks like this:
54
61
@@ -61,12 +68,12 @@ If there's a Hack Club or Hack Club community-led project (past or present) that
Every week, [thousands of people](https://plausible.io/hackclub.com) visit hackclub.com. What story to you want to tell?
76
+
Every week, thousands of people visit hackclub.com. What story to you want to tell?
70
77
71
78
_Have questions? Join us in [#hackclub-site-dev](https://hackclub.slack.com/archives/C036BTDGP43) and to learn more about the style guide at Hack Club check [this](https://hackclub.com/brand/) out_
0 commit comments