Skip to content

Commit 5733a57

Browse files
authored
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
1 parent a7d2e7f commit 5733a57

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,28 @@
44

55
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:
66

7-
Download the code to your computer:
7+
1. Download the code to your computer:
88

9-
$ git clone https://github.com/hackclub/site && cd site
9+
```bash
10+
git clone https://github.com/hackclub/site && cd site
11+
```
1012

11-
Install dependencies:
13+
2. Install dependencies:
1214

13-
$ yarn
15+
```bash
16+
yarn
17+
```
1418

15-
Start running the website on your computer:
19+
3. Start running the website on your computer:
1620

17-
$ yarn dev
21+
```bash
22+
yarn dev
23+
```
1824

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)
2026

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).
2229
2330
Powered by [Next.js] with [MDX], [Theme UI], & [Hack Club Theme].
2431
@@ -35,11 +42,11 @@ See something that could be better? Make a PR! Have an easter egg idea? Make a P
3542
If you need to add content to the site, here's how you can:
3643
3744
<details> <summary>Create a new card</summary>
38-
<img width="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">
3946
4047
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!
4148
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!
4350

4451
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 :)
4552

@@ -48,7 +55,7 @@ Your challenge: try and make the card as unique as possible, like a mini poster!
4855
<details>
4956
<summary>Add to the carousel</summary>
5057

51-
<img width="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">
5259

5360
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:
5461
@@ -61,12 +68,12 @@ If there's a Hack Club or Hack Club community-led project (past or present) that
6168
"description": "Our open love letter to hackers",
6269
"img": "https://a.slack-edge.com/production-standard-emoji-assets/14.0/apple-large/1f4bb@2x.png",
6370
"link": "/hackers-wanted"
64-
}
71+
}
6572
```
6673
6774
</details>
6875
69-
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?
7077
7178
_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_
7279

0 commit comments

Comments
 (0)