- 1. Astro Portfolio Template
- 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
- 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)
Note: this mini-guide assumes you have npm
installed on your machine, if you don't, you can download it following the instructions here
- Click on the "Use this template" button at the top of the repository.
- Create a new repository based on this template.
- Clone the repository to your local machine.
- Install the dependencies by running
npm install
- You can now start the development server by running
npm run dev
(see this section for more commands) - Now you can start customizing the portfolio template by updating the
/data/info.ts
file with your personal information.
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.
The RSS feed is generated using the astro-plugin-feed
plugin.
To customize it:
- Update the
site
entry in theastro.config.mjs
file with your site url. - Modify the
rss.xml.js
file located in thepages
directory to reflect your site's information.
Modify the head section of the BaseLayout.astro
file located in the src/layouts
directory to reflect your site's information.
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.
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
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 |
This portfolio template uses the following tools/libraries/resources:
If you would like to contribute to the Astro Portfolio Template, follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your forked repository.
- Submit a pull request to the main repository.
Thank you very much for your contributions!
See the CONTRIBUTING.md file for more information.
This project is licensed under the MIT License - see the LICENSE file for details.