1. Astro Portfolio Template

1.1. Table of Contents

• 1. Astro Portfolio Template
  • 1.1. Table of Contents
  • 1.2. Features 👐
  • 1.3. What's next? 🚀
  • 1.4. How to use this template 🧰
    • 1.4.1. Notes about the contact section 📧
    • 1.4.2. Notes about RSS feed 📰
    • 1.4.3. Notes about SEO 🤖
    • 1.4.4. Notes about styles 🎨
  • 1.5. Project Structure 🚀
  • 1.6. Commands 🧞‍♂️
  • 1.7. Tools Used 🛠️
  • 1.8. Contributing 🏗️
  • 1.9. License 📝

1.2. Features 👐

• Dark mode toggle
• Responsive design
• Easy to customize and extend personal data
• Fuzzy search for blog posts
• SEO friendly (robots.txt, sitemap.xml)
• RSS feed

1.3. What's next? 🚀

• Internationalization (i18n)
• Projects collection
• Feel free to open an issue or submit a pull request with your ideas for improving this portfolio template (see Contributing)

1.4. How to use this template 🧰

Note: this mini-guide assumes you have npm installed on your machine, if you don't, you can download it following the instructions here

1. Click on the "Use this template" button at the top of the repository.
2. Create a new repository based on this template.
3. Clone the repository to your local machine.
4. Install the dependencies by running npm install
5. You can now start the development server by running npm run dev (see this section for more commands)
6. Now you can start customizing the portfolio template by updating the /data/info.ts file with your personal information.

1.4.1. Notes about the contact section 📧

If you add/remove something from the contact section in the info.ts file, you will need to update the Contact.tsx file located in the src/components/contact_section directory by simply reflecting the changes you made in the info.ts file. Although, this choice may seem redundant, it allows to separate the data from the view.

1.4.2. Notes about RSS feed 📰

The RSS feed is generated using the astro-plugin-feed plugin.

To customize it:

1. Update the site entry in the astro.config.mjs file with your site url.
2. Modify the rss.xml.js file located in the pages directory to reflect your site's information.

1.4.3. Notes about SEO 🤖

Modify the head section of the BaseLayout.astro file located in the src/layouts directory to reflect your site's information.

1.4.4. Notes about styles 🎨

This portfolio template uses Tailwind CSS for styling. You can modify the colors used in the portfolio by updating the tailwind.config.js file located in the root of the project.

1.5. Project Structure 🚀

Inside of this portfolio template, you will find the following files and directories:

.
├── astro.config.mjs
├── LICENSE
├── package.json
├── package-lock.json
├── public
│   ├── favicon.svg
│   ├── pic.jpg
│   └── Resume.pdf
├── README.md
├── src
│   ├── components
│   │   ├── about_section
│   │   │   ├── About.tsx
│   │   │   ├── Education.tsx
│   │   │   └── Experience.tsx
│   │   ├── contact_section
│   │   │   └── Contact.tsx
│   │   ├── navbar
│   │   │   ├── Hamburger.tsx
│   │   │   └── Nav.jsx
│   │   ├── post_section
│   │   │   ├── Blog.astro
│   │   │   └── Post.astro
│   │   ├── projects_section
│   │   │   ├── ProjectCard.tsx
│   │   │   └── ProjectCarousel.tsx
│   │   ├── search
│   │   │   └── Search.tsx
│   │   ├── ToggleDarkMode.jsx
│   │   └── TopButton.jsx
│   ├── data
│   │   └── info.ts
│   ├── env.d.ts
│   ├── layouts
│   │   ├── BaseLayout.astro
│   │   └── PostLayout.astro
│   ├── pages
│   │   ├── index.astro
│   │   ├── posts
│   │   │   └── your-post-title.md
│   │   └── posts.astro
│   └── styles
│       └── global.css
├── tailwind.config.mjs
└── tsconfig.json

1.6. Commands 🧞‍♂️

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

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI

1.7. Tools Used 🛠️

This portfolio template uses the following tools/libraries/resources:

• Astro
• Tailwind CSS
• Font Awesome
• React
• TypeScript
• Fuse.js

1.8. Contributing 🏗️

If you would like to contribute to the Astro Portfolio Template, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.

Thank you very much for your contributions!

See the CONTRIBUTING.md file for more information.

1.9. License 📝

This project is licensed under the MIT License - see the LICENSE file for details.