Skip to content

Commit 08db234

Browse files
authored
Merge pull request #4 from gernotfasching/add-documentation
Add documentation
2 parents fd1fe87 + 96dc78f commit 08db234

File tree

3 files changed

+38
-0
lines changed

3 files changed

+38
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ There's nothing special about `src/components/`, but that's where we like to put
7474

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

77+
## Documentation
78+
List of documentation [Here](/docs/docs.md)
79+
7780
## 🧞 Commands
7881

7982
All commands are run from the root of the project, from a terminal:

docs/customization.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# ✏️ Customizing CVfolio
2+
3+
This guide walks you through how to customize the CVfolio template to reflect your personal profile, style, and content.
4+
5+
---
6+
7+
## 📁 Key Project Structure
8+
9+
Here’s an overview of folders relevant to customization:
10+
11+
| Path | Purpose |
12+
|--------------------------|-----------------------------------------------------------|
13+
| `src/assets/` | Fonts and static images (e.g., avatar, meta image) |
14+
| `src/components/` | UI and layout components (header, footer, etc.) |
15+
| `src/content/` | Editable content: jobs, links, posts, talks, pages |
16+
| `src/layouts/` | Astro layout templates |
17+
| `src/pages/` | Page routing (`index.astro`, `writing/`) |
18+
| `src/styles/global.css` | Global CSS and utility styles |
19+
| `src/lib/` | Utility functions and constants |
20+
21+
---
22+
23+
## 👤 Personal Information (Name, Bio, Avatar)
24+
25+
Update your **avatar**:
26+
- Replace the default image:

docs/docs.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# List of Documentation
2+
3+
Here is a list of documentation for more in depth information about the cvfolio.
4+
5+
| Documentation | Link |
6+
|--------------------------|-----------------------------------------------------------|
7+
| Customization | [docs/customization](/docs/customization.md) |
8+
9+
Feel free to add more documentation.

0 commit comments

Comments
 (0)