diff --git a/README.md b/README.md index f179f9f..c4f6ff6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ -# astro-personal-website -Personal Website template with blog and themes made with Astro +# Astro Minimalist Personal Website + +Minimalist Personal Website Template with Project Section, CV Section, Paginated Blog, RSS Feed, SEO Friendly, Visual themes and Responsive Desing for Astro framework. + +## Installation + +Run the following command in your terminal + +``` bash +npm install +``` + +Once the packages are installed you are ready to run astro. Astro comes with a built-in development server that has everything you need for project development. The astro dev command will start the local development server so that you can see your new website in action for the very first time. + +``` bash +npm run dev +``` + +### Tech Stack + +- [Astro](astro.build) +- [tailwindcss](https://tailwindcss.com/) +- [DaisyUI](https://daisyui.com/) + + ## Project Strucutre @@ -12,23 +35,107 @@ Personal Website template with blog and themes made with Astro │ │ ├── Card.astro │ │ ├── Footer.astro │ │ ├── Header.astro -│ │ └-─ HorizontalCard.jsx -│ │ └-─ SideBar.jsx +│ │ └── HorizontalCard.jsx +│ │ └── SideBar.jsx │ ├── layouts/ -│ │ └-─ BaseLayout.astro -│ │ └-─ PostLayout.astro +│ │ └── BaseLayout.astro +│ │ └── PostLayout.astro │ └── pages/ -│ │ ├── posts/ +│ │ ├── blog/ +│ │ │ ├── [page].astro │ │ │ ├── post1.md │ │ │ ├── post2.md │ │ │ └── post3.md +│ │ └── cv.astro │ │ └── index.astro +│ │ └── projects.astro +│ │ └── rss.xml.js │ └── styles/ -│ └-─ global.css +│ └── global.css ├── public/ │ ├── favicon.svg -│ └-─ social-image.png +│ └── social-image.png +│ └── sprofile.jpg +│ └── social_img.webp ├── astro.config.mjs +├── tailwind.config.cjs ├── package.json └── tsconfig.json ``` + +### Components usage + +#### Layout Components + +The `BaseHead`, `Footer`, `Header` and `SideBar` components are already included in the layout sistem. To change the website content you can edit the content of this componenets. +#### TimeLine + +The timeline components are used to conform the CV. + +``` html +