Skip to content

Commit

Permalink
feat: Add archetypes
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Sep 21, 2020
1 parent cbed5d0 commit dab6d07
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 27 deletions.
56 changes: 31 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Hugo IRIS Theme
- [Getting Started](#getting-started)
- [Get Hugo](#get-hugo)
- [Initialize New Hugo Project](#initialize-new-hugo-project)
- [Params](#params)
- [Site](#site)
- [Post Page Front Matter](#post-page-front-matter)
- [Create a Post Page](#create-a-post-page)
- [Create a Slide Page](#create-a-slide-page)
- [Site Params](#site-params)
- [Customize Theme](#customize-theme)
- [config](#config)
- [content](#content)
Expand Down Expand Up @@ -88,12 +88,13 @@ This repository includes the [Hugo] theme.
### Roadmap

- Share Buttons
- JSON-LD
- Netlify, Netlify CMS
- Categories, Tags, Authors
- Font Awesome
- Related posts, next and previous post

<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>



## Getting Started
Expand All @@ -120,30 +121,27 @@ hugo server

*Customize your site! ʕ◔ϖ◔ʔ*

### Create a Post Page

```sh
hugo new posts/new.md
```

## Params
### Create a Slide Page

### Site
```sh
hugo new --kind slide posts/new-slide.md
```

TBW.
<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>

### Post Page Front Matter

```yaml
title:
description:
publishdate: 2020-01-01T01:00:00.000Z
# draft: true
eyecatch: images/eyecatch.jpg
toc: true
# math: true
# weight: 1
twitter:
username: piris314
hashtags: ["Hugo"]
canonicalURL:
```

## Site Params

TBW.

<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>



Expand All @@ -163,6 +161,8 @@ TBW.

### static

<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>



## Hosting
Expand Down Expand Up @@ -222,6 +222,8 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>
## Shortcodes
Expand Down Expand Up @@ -342,6 +344,8 @@ Please follow the instruction as the same as the `repo` shortcode.
|---|---|
| ![Shortcode table mouse out](https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/exampleSite/static/images/shortcode_table_1.jpg) | ![Shortcode table mouse over](https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/exampleSite/static/images/shortcode_table_2.jpg) |

<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>



## How to Update the Theme
Expand All @@ -360,6 +364,8 @@ git commit -m "deps: bump hugo-theme-iris to v0.x.y"
git push origin master
```

<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>



## Special Thanks
Expand All @@ -371,6 +377,8 @@ git push origin master
<!-- - [mermaid] -->
<!-- - Font Awesome -->

<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>



## Changelog
Expand Down Expand Up @@ -401,9 +409,7 @@ You can find more detail in our [Contributing Guide].

---

<div align="right">
<a href="#table-of-contents">Back to TOC ☝️</a>
</div>
<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>



Expand Down
13 changes: 11 additions & 2 deletions archetypes/default.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
+++
+++
---
title: "{{ replace .Name "-" " " | title }}"
description:
publishdate: {{ .Date }}
# draft: true
eyecatch: images/eyecatch.jpg
toc: true
# math: true
# weight: 1
# canonicalURL:
---
11 changes: 11 additions & 0 deletions archetypes/slide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "{{ replace .Name "-" " " | title }}"
description:
publishdate: {{ .Date }}
# draft: true
eyecatch: images/eyecatch.jpg
toc: true
slide: true
# weight: 1
# canonicalURL:
---

0 comments on commit dab6d07

Please sign in to comment.