From 7c8d8752bfbb16c2739caee26e6e42814e42ca20 Mon Sep 17 00:00:00 2001 From: Manuel Ernesto Garcia Date: Tue, 27 Sep 2022 11:44:13 -0400 Subject: [PATCH] updating readme file and some other stufs --- README.md | 125 ++++++++++++++++++++++++++-- package.json | 4 +- src/components/Card.astro | 4 +- src/components/HorizontalCard.astro | 6 +- src/pages/blog/post1.md | 2 +- src/pages/blog/post2.md | 2 +- src/pages/blog/post3.md | 2 +- src/pages/cv.astro | 2 +- src/pages/index.astro | 2 +- 9 files changed, 127 insertions(+), 22 deletions(-) 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 +
+ + ... +
+``` + +#### Card & HorizontalCard +``` html + +``` + +### Layouts + +Include `BaseLayout` in each page you add and `PostLayout` to your post pages. + +### Pages + +#### Blog + +Add your `md` blog post in the `/pages/blog/` folder. + +#### [page].astro + +The `[page].astro` is the route to work with the paginated post list. You can change there the number of items listed for each page and the pagination button labels. + +##### Post format +Add code with this format in the top of each post file. +``` +--- +layout: "../../layouts/PostLayout.astro" +title: "Post Title" +description: "Description" +pubDate: "Post date format(Sep 10 2022)" +heroImage: "Post Hero Image URL" +--- +``` +#### Static pages + +The other pages inlcuded in the template are static pages. The `index` page belong to the root page. You can add your pages directly in the `/pages` folder and then add a link to that pages in the `sidebar` component. + +Feel free to modify the content included in the pages that the template contains or add the ones you need. + +### Theming + +For change the template theme change the `data-theme` atribute of the `` tag in `BaseLayout.astro` file. + +You can chose among 30 themes available or create your custom theme. See themes available [here](https://daisyui.com/docs/themes/). + +### Deploy + +The configuration for the deployment varies depending on the platform where you are going to do it. See the [official Astro information](https://docs.astro.build/en/guides/deploy/) to deploy your website. + + + diff --git a/package.json b/package.json index 825ab2c..5978197 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "Astro Personal Website Template", - "description": "Astro personal website template with Project Section, CV Section, Paginated Blog, RSS Feed, SEO Friendly, Visual themes and Responsive Desing.", + "name": "Astro Minimalist Personal Website", + "description": "Astro Minimalist personal website template with Project Section, CV Section, Paginated Blog, RSS Feed, SEO Friendly, Visual themes and Responsive Desing.", "type": "module", "version": "1.0.0", "private": true, diff --git a/src/components/Card.astro b/src/components/Card.astro index bf6b51f..b2749f8 100644 --- a/src/components/Card.astro +++ b/src/components/Card.astro @@ -1,9 +1,9 @@ --- -const { title, img, desc, url, badge, tags } = Astro.props; +const { title, img, desc, url, badge, tags, target = '_blank' } = Astro.props; ---
- +
Shoes
diff --git a/src/components/HorizontalCard.astro b/src/components/HorizontalCard.astro index cae97d9..c9d268d 100644 --- a/src/components/HorizontalCard.astro +++ b/src/components/HorizontalCard.astro @@ -1,11 +1,9 @@ --- -const { title, img, desc, url, badge, tags, target } = Astro.props; - -let cardTarget = target ? target : "_blank"; +const { title, img, desc, url, badge, tags, target = '_blank' } = Astro.props; ---
- +
diff --git a/src/pages/blog/post1.md b/src/pages/blog/post1.md index 49b5100..a8e2cf9 100644 --- a/src/pages/blog/post1.md +++ b/src/pages/blog/post1.md @@ -1,5 +1,5 @@ --- -layout: "../../layouts/BlogPost.astro" +layout: "../../layouts/PostLayout.astro" title: "Demo Post 1" description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." pubDate: "Sep 10 2022" diff --git a/src/pages/blog/post2.md b/src/pages/blog/post2.md index 6803dcc..445f2cf 100644 --- a/src/pages/blog/post2.md +++ b/src/pages/blog/post2.md @@ -1,5 +1,5 @@ --- -layout: "../../layouts/BlogPost.astro" +layout: "../../layouts/PostLayout.astro" title: "Demo Post 2" description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." pubDate: "Sep 11 2022" diff --git a/src/pages/blog/post3.md b/src/pages/blog/post3.md index 4a2cd76..b2b0d29 100644 --- a/src/pages/blog/post3.md +++ b/src/pages/blog/post3.md @@ -1,5 +1,5 @@ --- -layout: "../../layouts/BlogPost.astro" +layout: "../../layouts/PostLayout.astro" title: "Demo Post 3" description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." pubDate: "Sep 12 2022" diff --git a/src/pages/cv.astro b/src/pages/cv.astro index 59937cc..a98ce5d 100644 --- a/src/pages/cv.astro +++ b/src/pages/cv.astro @@ -34,7 +34,7 @@ import TimeLineElement from "../components/cv/TimeLine.astro";
Experience
-
+
-
Last from blog
+
Latest from blog
{