Add Netlify status badges and demo link to the readme

This commit is contained in:
Track3 2019-02-14 16:29:13 +08:00
parent 61592cc6fb
commit ad75aca5c2
2 changed files with 7 additions and 3 deletions

View file

@ -1,5 +1,7 @@
# Hugo theme Hermit # Hugo theme Hermit
[![Netlify Status](https://api.netlify.com/api/v1/badges/01a2e2de-d57d-4d89-8322-95685000e60f/deploy-status)](https://app.netlify.com/sites/hugo-theme-hermit/deploys)
Hermit is a minimal and fast theme for Hugo. It's built for bloggers who want a simple and focused website. Hermit is a minimal and fast theme for Hugo. It's built for bloggers who want a simple and focused website.
![](https://github.com/Track3/hermit/raw/master/images/screenshot.png) ![](https://github.com/Track3/hermit/raw/master/images/screenshot.png)
@ -13,13 +15,15 @@ Hermit is a minimal and fast theme for Hugo. It's built for bloggers who want a
* Extremely lightweight and load fast. No third party framework, no unnecessary code. * Extremely lightweight and load fast. No third party framework, no unnecessary code.
* Responsive & Retina Ready. Scales gracefully from a big screen all the way down to the smallest mobile phone. Assets in vector format ensures that it looks sharp on high-resolution screens. * Responsive & Retina Ready. Scales gracefully from a big screen all the way down to the smallest mobile phone. Assets in vector format ensures that it looks sharp on high-resolution screens.
**[Theme Demo](https://hugo-theme-hermit.netlify.com/)** (uses contents and config from the `exampleSite` folder)
![](https://github.com/Track3/hermit/raw/master/images/hermit.png) ![](https://github.com/Track3/hermit/raw/master/images/hermit.png)
## Getting started ## Getting started
### Installation ### Installation
Run this command from the root of your Hugo directory (Git needs to be installed): Run this command from the root of your Hugo directory:
```bash ```bash
$ git clone https://github.com/Track3/hermit.git themes/hermit $ git clone https://github.com/Track3/hermit.git themes/hermit

View file

@ -43,8 +43,8 @@ enableEmoji = true # Shorthand emojis in content files - https://gohugo.io/func
# Prefix of link to the git commit detail page. GitInfo must be enabled. # Prefix of link to the git commit detail page. GitInfo must be enabled.
# gitUrl = "https://github.com/username/repository/commit/" # gitUrl = "https://github.com/username/repository/commit/"
# Toggle this option need to rebuild SCSS, requires extended version of Hugo # Toggling this option needs to rebuild SCSS, requires Hugo extended version
justifyContent = false # Set "text-align: justify" to .content. justifyContent = false # Set "text-align: justify" to `.content`.
# Add custom css # Add custom css
# customCSS = ["css/foo.css", "css/bar.css"] # customCSS = ["css/foo.css", "css/bar.css"]