Skip to content

Commit ee0e8ed

Browse files
committed
docs: update README with new workflow
- Document new Content Collection structure\n- Update development and contribution guidelines
1 parent 11ca07c commit ee0e8ed

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

README.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,46 @@ The goal of this repository is to collect mechanical keyboard related projects (
55

66
View the pages on [Keebfolio.netlify.app](https://keebfolio.netlify.app/) or GitHub:
77

8-
- [Staggered](src/pages/en/staggered.md)
9-
- [Ortho](src/pages/en/ortholinear.md)
10-
- [Split](src/pages/en/split.md)
11-
- [Other](src/pages/en/other.md)
8+
- [Staggered](src/content/keyboards/staggered/)
9+
- [Ortho](src/content/keyboards/ortholinear/)
10+
- [Split](src/content/keyboards/split/)
11+
- [Other](src/content/keyboards/other/)
1212
- [Firmware](src/pages/en/firmware.md)
1313
- [Miscellaneous](src/pages/en/miscellaneous.md)
1414
- [Tools](src/pages/en/tools.md)
1515
- [Tutorials](src/pages/en/tutorials.md)
1616

1717
## Contributing
1818

19-
Contributions are welcome!  
20-
To add content, edit the Markdown file in the [src/pages/en](src/pages/en/) folder and open a [Pull Request](https://help.github.com/en/articles/about-pull-requests). You can also open a new [Issue](https://github.com/Keycapsss/awesome-mechanical-keyboard/issues).
21-
Please use this [commit message conventions](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13).
19+
Contributions are welcome!
20+
To add content, create a new Markdown file in `src/content/keyboards/[category]/`.
21+
You can copy an existing file as a template.
2222

23-
The project uses [Astro](https://astro.build) as a Static Site Generator.
24-
[![Netlify Status](https://api.netlify.com/api/v1/badges/06821f1d-3e33-4bd4-92b2-4e44f3583060/deploy-status)](https://app.netlify.com/sites/keebfolio/deploys)
23+
**New Image Policy:**
24+
- You can use remote URLs (e.g. `https://github.com/.../image.jpg`).
25+
- The build process will **automatically download and optimize** them for you.
2526

26-
#### Creating local development environment
27+
### Development Environment
2728

28-
##### Creating Github Auth Token
29+
1. Clone the repository.
30+
2. Install dependencies:
31+
```bash
32+
npm install
33+
```
34+
3. Start the development server:
35+
```bash
36+
npm run dev
37+
```
38+
Open [http://localhost:4321](http://localhost:4321) to view the site.
2939

30-
1. ~~Go to `https://github.com/settings/tokens`~~
31-
2. ~~Click "Generate new token"~~
32-
3. ~~Set note and expiration, then click "Generate token"~~
33-
4. ~~Copy generated token, you will need it in another step~~
40+
### Housekeeping
3441

35-
##### Installation and running local version
42+
- **Cleanup Unused Images**:
43+
```bash
44+
npm run cleanup
45+
```
46+
This deletes any downloaded images that are no longer referenced in your Markdown files.
3647

37-
1. ~~Create environment variables:~~
38-
- ~~`GITHUB_AUTH_TOKEN` with generated token as its value.~~
39-
- ~~`GITHUB_API_V4_URL` with value `https://api.github.com/graphql`~~
40-
2. ~~Clone repository~~
41-
3. ~~`npm install`~~
42-
5. ~~`npm run develop`~~
4348

4449
### License
4550

0 commit comments

Comments
 (0)