Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/peaceiris/hugo-theme-iris.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpeaceiris <30958501+peaceiris@users.noreply.github.com>2020-01-28 01:18:27 +0300
committerpeaceiris <30958501+peaceiris@users.noreply.github.com>2020-01-28 01:18:27 +0300
commitcca6d6c325d4f43d01308efa0dcaf2c37b6bb789 (patch)
tree7c99fe58a8acaf93419e2c51c5a5736b31068e4f /README.md
parente534927f04d854ae727743186cfc6bcb450aea7e (diff)
docs: Add Overview
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 11 insertions, 18 deletions
diff --git a/README.md b/README.md
index 59d1d89d..14256d26 100644
--- a/README.md
+++ b/README.md
@@ -8,16 +8,6 @@ Hugo IRIS Theme
<img src="https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/images/tn.png" alt="thumbnail" width="500px">
</div>
-This repository includes the [Hugo] theme.
-
-- Writing slides using Markdown. ([reveal.js])
-- [MathJax] on slides.
-- Diagram and flowchart on slides. ([mermaid])
-
-This theme can manage and publish slides using Hugo.
-
-- [Demo (Netlify)]
-
## Table of Contents
@@ -26,9 +16,8 @@ This theme can manage and publish slides using Hugo.
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-- [Features](#features)
- - [MathJax](#mathjax)
- - [mermaid](#mermaid)
+- [Overview](#overview)
+ - [Features](#features)
- [Installation](#installation)
- [Download theme](#download-theme)
- [Hosting](#hosting)
@@ -43,16 +32,20 @@ This theme can manage and publish slides using Hugo.
-## Features
+## Overview
+This repository includes the [Hugo] theme.
+
+- [Demo (Netlify)]
+- Demo on GitHub Pages
+
+### Features
+
+- 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.
- PageSpeed Insights Scores: Mobile `100`, Desktop `100`
-### MathJax
-
-### mermaid
-
## Installation