Skip to content

Commit

Permalink
post-article dev docs added
Browse files Browse the repository at this point in the history
Relates to #719
  • Loading branch information
naher94 committed May 24, 2024
1 parent 497ebc8 commit 5e23324
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,19 @@ big-tile | Whether it renders as a big tile on `/photography` | `bool` eg. `true
date | `YYYY-MM-DD` | `date`
display-date | Use in the case of multiple dates | `string` eg. `Winter 2012 & Spring 2022`

#### Type `post-article`

Tag | Use | Data Type
:--- | :--- | :---
layout | The template for structural reference | `.html`
article | Should always be `true` as it helps set the link type across the site | `bool` eg. `true`
title | The name of the article | `string`
description | A short explanation of the article | `string`
hero-image | The image that loads into the hero section | `path` as a `string` eg. `product-principles-strategies/hero.jpg`; File should be an `.jpg` aspect ratio 2x1
hero-image-alt | The `alt` text for the hero image | `string` eg. `Illustration of Pepper the Product Panda excited to showcase product principles and strategies`
tags | an array of related topics for the resource `[leadership,product development]` | comma separated `string`
content-type | The media type such as reference, tool, interactive, video, my content, reading, publication, portfolio, article, blog. | `string`
date | `YYYY-MM-DD` | `date`

#### `_resources` Frontmatter Tags

Expand All @@ -162,6 +175,7 @@ title | The main name that references the resource in each tile | `string`
link | The external `url` to the resource | `string`
description | A short explanation of the resource | `string`
tags | an array of related topics for the resource `[film,games,tools]` | comma separated `string`
content-type | The media type such as reference, tool, interactive, video, my content, reading, publication, portfolio, article, blog. | `string`

#### `_work-experience` Frontmatter Tags

Expand Down

0 comments on commit 5e23324

Please sign in to comment.