blob: 30993f35b69f6dff8b0a6ad57cc310c6dea2ec6a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
[](https://github.com/peaceiris/hugo-theme-iris/blob/master/LICENSE)
<h2 align="center">
Hugo IRIS Theme
</h2>
<div align="center">
<img src="https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/images/tn.png" alt="thumbnail" width="500px">
</div>
## Table of Contents
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Overview](#overview)
- [Features](#features)
- [Roadmap](#roadmap)
- [Installation](#installation)
- [Download theme](#download-theme)
- [Hosting](#hosting)
- [Netlify](#netlify)
- [GitHub Pages](#github-pages)
- [Special Thanks](#special-thanks)
- [Maintainer](#maintainer)
- [Contributing](#contributing)
- [License](#license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Overview
This repository includes the [Hugo] theme.
- Demo site on GitHub Pages
### Features
- Dark theme
- Support Multilingual
<!-- - PageSpeed Insights Scores: Mobile `100`, Desktop `100` -->
### Roadmap
- Netlify, Netlify CMS
- Writing slides using Markdown. ([reveal.js])
- [MathJax]: Beautiful math in all browsers.
- [mermaid]: Generation of diagram and flowchart from text in a similar manner as markdown.
## Installation
### Download theme
## Hosting
### Netlify
<!-- Deploy to Netlify Button -->
<!-- https://www.netlify.com/docs/deploy-button/ -->
[](https://app.netlify.com/start/deploy?repository=https://github.com/peaceiris/hugo-theme-iris)
### GitHub Pages
GitHub Actions.
## Special Thanks
- [Hugo]
- [Bulma]
<!-- - [reveal.js] -->
<!-- - [MathJax] -->
<!-- - [mermaid] -->
## Maintainer
- [peaceiris homepage](https://peaceiris.com)
## Contributing
To contribute to this Hugo theme.
You can find more detail in our [Contributing Guide].
## License
- [MIT License - peaceiris/hugo-theme-iris](https://github.com/peaceiris/hugo-theme-iris/blob/master/LICENSE)
---
<div align="right">
<a href="#table-of-contents">Back to TOC ☝️</a>
</div>
<!-- Internal References -->
[Contributing Guide]: https://github.com/peaceiris/hugo-theme-iris/blob/master/CONTRIBUTING.md
<!-- External References -->
[Hugo]: https://gohugo.io/
[Bulma]: https://bulma.io/
[reveal.js]: https://github.com/hakimel/reveal.js/
[MathJax]: https://www.mathjax.org/
[mermaid]: https://github.com/knsv/mermaid
|
