Skip to content

Commit babb6da

Browse files
committed
Update README with current project documentation
1 parent 1455eb9 commit babb6da

File tree

1 file changed

+70
-14
lines changed

1 file changed

+70
-14
lines changed

README.md

Lines changed: 70 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,76 @@
1-
# marcopisco.com
2-
![GitHub last commit](https://img.shields.io/github/last-commit/marpisco/marcopisco.com)
3-
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/marpisco/marcopisco.com)
4-
![GitHub languages](https://img.shields.io/github/languages/top/marpisco/marcopisco.com)
1+
# Marco Pisco Website
52

6-
![Screenshot of Website](https://image.thum.io/get/maxAge/1/width/500/https://marcopisco.com)
3+
Personal website source for [marcopisco.com](https://marcopisco.com), built with TypeScript + Vite and deployed with GitHub Pages.
74

8-
My personal website's code.
5+
![GitHub last commit](https://img.shields.io/github/last-commit/marpisco/marpisco.github.io)
6+
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/marpisco/marpisco.github.io)
7+
![GitHub language count](https://img.shields.io/github/languages/count/marpisco/marpisco.github.io)
98

10-
## Table of Contents
11-
On the root of this repository there are 3 files. The site itself, the README you're reading, and the pointless license (because nobody will ever actually use this other than myself).
9+
## Tech Stack
1210

13-
## License
14-
This repository and work are licensed under the **GNU General Public License v3.0**. You can read the license and research about it.
11+
- TypeScript
12+
- Vite
13+
- Vanilla HTML/CSS
14+
- GitHub Actions + GitHub Pages
15+
- Lanyard WebSocket API (Discord live presence)
16+
17+
## Features
18+
19+
- Single-page portfolio layout (hero, about, tech stack, experience, education, contact)
20+
- Live Discord presence cards using Lanyard WebSocket
21+
- Posts section backed by local Markdown files
22+
- Smooth reveal and hover animations
23+
- Responsive layout for desktop and mobile
24+
25+
## Local Development
26+
27+
```bash
28+
npm install
29+
npm run dev
30+
```
31+
32+
Default dev URL: `http://localhost:5173`
33+
34+
## Build and Preview
35+
36+
```bash
37+
npm run build
38+
npm run preview
39+
```
40+
41+
The production build is generated in `dist/`.
42+
43+
## Posts Workflow
1544

16-
## Warranty
17-
This website will be updated whenever I need it updated, and whenever I feel like it. There isn't a schedule of updates for it.
45+
Posts are loaded from the `public/writeups` directory:
46+
47+
- `public/writeups/index.json` contains metadata for each post
48+
- `public/writeups/<slug>.md` contains the Markdown content
49+
50+
Example `index.json` item:
51+
52+
```json
53+
{
54+
"slug": "example-post",
55+
"title": "Example Post",
56+
"date": "2026-01-15",
57+
"summary": "Short summary.",
58+
"tags": ["tag1", "tag2"]
59+
}
60+
```
61+
62+
## Deployment
63+
64+
Deployment is fully automated by [`.github/workflows/deploy-pages.yml`](.github/workflows/deploy-pages.yml):
65+
66+
1. Trigger on push to `main`
67+
2. Install dependencies with `npm ci`
68+
3. Build with `npm run build`
69+
4. Upload `dist/` artifact
70+
5. Deploy to GitHub Pages
71+
72+
Custom domain is configured via `CNAME` (`marcopisco.com`).
73+
74+
## License
1875

19-
## Credits
20-
Nobody else other than me worked on this project. Have an idea or a better way to do what I did? Great, make a pull request and I might approve it.
76+
This project is licensed under the GNU General Public License v3.0. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)