mirror of
https://codeberg.org/andyscott-pages/andyscott-dot-me.git
synced 2024-12-22 09:43:11 -05:00
updating readme file
This commit is contained in:
parent
7ded9bfa57
commit
2ff9653f10
4 changed files with 49 additions and 5 deletions
49
README.md
49
README.md
|
@ -103,7 +103,7 @@ The timeline components are used to conform the CV.
|
||||||
``` html
|
``` html
|
||||||
<HorizontalCard
|
<HorizontalCard
|
||||||
title="Card Title"
|
title="Card Title"
|
||||||
img="imge_url""
|
img="imge_url"
|
||||||
desc="Description"
|
desc="Description"
|
||||||
url="Link URL"
|
url="Link URL"
|
||||||
target="Optional link target (_blank default)"
|
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
|
### Layouts
|
||||||
|
|
||||||
Include `BaseLayout` in each page you add and `PostLayout` to your post pages.
|
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.
|
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.
|
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"
|
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
|
#### 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.
|
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.
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
"name": "Astro Modern Personal Website",
|
"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.",
|
"description": "Astro Modern personal website template with Project Section, CV Section, Paginated Blog, RSS Feed, SEO Friendly, Visual themes and Responsive Desing.",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"version": "1.0.0",
|
"version": "1.1.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "astro dev",
|
"dev": "astro dev",
|
||||||
|
|
|
@ -5,7 +5,7 @@ const {
|
||||||
desc,
|
desc,
|
||||||
url,
|
url,
|
||||||
badge,
|
badge,
|
||||||
target = "_blank",
|
target = "_self",
|
||||||
pricing,
|
pricing,
|
||||||
oldPricing,
|
oldPricing,
|
||||||
checkoutUrl,
|
checkoutUrl,
|
||||||
|
|
|
@ -8,7 +8,6 @@ custom_link: "https://demourl.com/"
|
||||||
pubDate: "Sep 15 2022"
|
pubDate: "Sep 15 2022"
|
||||||
pricing: "$15"
|
pricing: "$15"
|
||||||
badge: "Featured"
|
badge: "Featured"
|
||||||
tags: ['Tag1','Tag2']
|
|
||||||
checkoutUrl: "https://checkouturl.com/"
|
checkoutUrl: "https://checkouturl.com/"
|
||||||
heroImage: "/itemPreview.png"
|
heroImage: "/itemPreview.png"
|
||||||
---
|
---
|
||||||
|
|
Loading…
Reference in a new issue