diff options
author | peaceiris <30958501+peaceiris@users.noreply.github.com> | 2020-01-28 01:18:27 +0300 |
---|---|---|
committer | peaceiris <30958501+peaceiris@users.noreply.github.com> | 2020-01-28 01:18:27 +0300 |
commit | cca6d6c325d4f43d01308efa0dcaf2c37b6bb789 (patch) | |
tree | 7c99fe58a8acaf93419e2c51c5a5736b31068e4f | |
parent | e534927f04d854ae727743186cfc6bcb450aea7e (diff) |
docs: Add Overview
-rw-r--r-- | README.md | 29 |
1 files changed, 11 insertions, 18 deletions
@@ -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 |