diff options
author | Shohei Ueda <30958501+peaceiris@users.noreply.github.com> | 2019-12-13 06:45:40 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-13 06:45:40 +0300 |
commit | f895976c11109ddf475303266ec1634dbd64f38a (patch) | |
tree | e58d77456466cd560436b722c79ceb7b455a8eea /README.md | |
parent | 79408005e8b2a0d81f1215504fb3c49972d0d74f (diff) |
docs: update
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 35 |
1 files changed, 6 insertions, 29 deletions
@@ -1,9 +1,9 @@ -## Hugo Iris Theme +## Hugo IRIS Theme <!-- https://shields.io/ --> -[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/peaceiris/hugo-iris/blob/master/LICENSE) +[![LICENSE](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/peaceiris/hugo-iris/blob/master/LICENSE) -This repository includes the [Hugo] theme for your presentation. +This repository includes the [Hugo] theme. - Writing slides using Markdown. ([reveal.js]) - [MathJax] on slides. @@ -66,11 +66,7 @@ This theme can manage and publish slides using Hugo. ### GitHub Pages -- [Host on GitHub | Hugo] - -The next method is recommended. - -- [Deployment of Project Pages From Your gh-pages branch] +GitHub Actions. @@ -85,33 +81,22 @@ The next method is recommended. ## Author -- peaceiris - - [GitHub] - - [Twitter] +- [peaceiris homepage](https://peaceiris.com) ## Contributing -To contribute to this hugo theme. - -1. Fork this repo locally. -2. Find or Open [GitHub Issues]. -3. Commit your code on a separate branch. -4. Send your Pull Request. +To contribute to this Hugo theme. You can find more detail in our [Contributing Guide]. -Participation in this open source project is subject to a [Code of Conduct]. - ## License This theme is released under the [MIT License]. -Copyright © 2019, peaceiris - --- @@ -125,18 +110,10 @@ Copyright © 2019, peaceiris [Demo (Netlify)]: https://hugoiris.netlify.com/ [MIT License]: ./LICENSE -[GitHub Issues]: https://github.com/peaceiris/hugo-iris/issues [Contributing Guide]: ./CONTRIBUTING.md -[Code of Conduct]: ./CODE_OF_CONDUCT.md - -[GitHub]: https://github.com/peaceiris -[Twitter]: https://twitter.com/piris314en <!-- External References --> [Hugo]: https://gohugo.io/ [reveal.js]: https://github.com/hakimel/reveal.js/ [MathJax]: https://www.mathjax.org/ [mermaid]: https://github.com/knsv/mermaid - -[Host on GitHub | Hugo]: https://gohugo.io/hosting-and-deployment/hosting-on-github/ -[Deployment of Project Pages From Your gh-pages branch]: https://gohugo.io/hosting-and-deployment/hosting-on-github/#deployment-of-project-pages-from-your-gh-pages-branch |