updating readme file

This commit is contained in:
Manuel Ernesto Garcia 2022-10-23 17:09:49 -04:00
parent 7ded9bfa57
commit 2ff9653f10
4 changed files with 49 additions and 5 deletions

View file

@ -103,7 +103,7 @@ The timeline components are used to conform the CV.
``` html
<HorizontalCard
title="Card Title"
img="imge_url""
img="imge_url"
desc="Description"
url="Link URL"
target="Optional link target (_blank default)"
@ -112,6 +112,25 @@ The timeline components are used to conform the CV.
/>
```
#### HorizontalCard Shop Item
This compoenet is already included in the Store layout of the template. In case you want to use it in other place this are the props.
``` html
<HorizontalShopItem
title= "Item Title"
img= "imge_url"
desc= "Item description"
pricing= "current_price"
oldPricing= "old_price"
checkoutUrl= "external store checkout url"
badge="Optional badge"
details= true # show or hide details btn (default is true)
url= "item details url"
custom_link= "Custom link url"
custom_link_label= "Cutom link btn label" target="Optional link target (_self default)"
/>
```
### Layouts
Include `BaseLayout` in each page you add and `PostLayout` to your post pages.
@ -122,7 +141,7 @@ Include `BaseLayout` in each page you add and `PostLayout` to your post pages.
Add your `md` blog post in the `/pages/blog/` folder.
#### [page].astro
##### [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.
@ -137,6 +156,32 @@ pubDate: "Post date format(Sep 10 2022)"
heroImage: "Post Hero Image URL"
---
```
#### Shop
Add your `md` item in the `/pages/shop/` folder.
##### [page].astro
The `[page].astro` is the route to work with the paginated item list. You can change there the number of items listed for each page and the pagination button labels. The shop will render all `.md` files you incle inside this folder.
##### Item format
Add code with this format in the top of each item file.
``` js
---
layout: "../../layouts/StoreItemLayout.astro"
title: "Demo Item 1"
description: "Item description"
heroImage: "Item img url"
details: true // show or hide details btn
custom_link_label: "Custom btn link label"
custom_link: "Custom btn link"
pubDate: "Sep 15 2022"
pricing: "$15"
oldPricing: "$25.5"
badge: "Featured"
checkoutUrl: "https://checkouturl.com/"
---
```
#### 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.

View file

@ -2,7 +2,7 @@
"name": "Astro Modern Personal Website",
"description": "Astro Modern 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",
"version": "1.1.0",
"private": true,
"scripts": {
"dev": "astro dev",

View file

@ -5,7 +5,7 @@ const {
desc,
url,
badge,
target = "_blank",
target = "_self",
pricing,
oldPricing,
checkoutUrl,

View file

@ -8,7 +8,6 @@ custom_link: "https://demourl.com/"
pubDate: "Sep 15 2022"
pricing: "$15"
badge: "Featured"
tags: ['Tag1','Tag2']
checkoutUrl: "https://checkouturl.com/"
heroImage: "/itemPreview.png"
---