diff --git a/README.md b/README.md index 511696e..834da6d 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/docs/customization.md b/docs/customization.md new file mode 100644 index 0000000..48a3a17 --- /dev/null +++ b/docs/customization.md @@ -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: diff --git a/docs/docs.md b/docs/docs.md new file mode 100644 index 0000000..dcd6f6a --- /dev/null +++ b/docs/docs.md @@ -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.