Skip to content

Add documentation #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ There's nothing special about `src/components/`, but that's where we like to put

Any static assets, like images, can be placed in the `public/` directory.

## Documentation
List of documentation [Here](/docs/docs.md)

## 🧞 Commands

All commands are run from the root of the project, from a terminal:
Expand Down
26 changes: 26 additions & 0 deletions docs/customization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# ✏️ Customizing CVfolio

This guide walks you through how to customize the CVfolio template to reflect your personal profile, style, and content.

---

## 📁 Key Project Structure

Here’s an overview of folders relevant to customization:

| Path | Purpose |
|--------------------------|-----------------------------------------------------------|
| `src/assets/` | Fonts and static images (e.g., avatar, meta image) |
| `src/components/` | UI and layout components (header, footer, etc.) |
| `src/content/` | Editable content: jobs, links, posts, talks, pages |
| `src/layouts/` | Astro layout templates |
| `src/pages/` | Page routing (`index.astro`, `writing/`) |
| `src/styles/global.css` | Global CSS and utility styles |
| `src/lib/` | Utility functions and constants |

---

## 👤 Personal Information (Name, Bio, Avatar)

Update your **avatar**:
- Replace the default image:
9 changes: 9 additions & 0 deletions docs/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# List of Documentation

Here is a list of documentation for more in depth information about the cvfolio.

| Documentation | Link |
|--------------------------|-----------------------------------------------------------|
| Customization | [docs/customization](/docs/customization.md) |

Feel free to add more documentation.