diff options
author | Przemysław Kołodziejczyk <eshlox@vertolabs.com> | 2018-05-06 20:56:04 +0300 |
---|---|---|
committer | Przemysław Kołodziejczyk <eshlox@vertolabs.com> | 2018-05-06 20:56:04 +0300 |
commit | 20db932fa307b7c143f9c1520b3dc6ce204aec0a (patch) | |
tree | 27ab78f186a3c8aef88fb3533e1adb98c96d5304 | |
parent | d18ca94c320db2a4e9ebc0bb96202b8a5310a77e (diff) |
Update README
-rw-r--r-- | README.md | 111 |
1 files changed, 87 insertions, 24 deletions
@@ -2,20 +2,46 @@ Very simple, clean and readable (I think so) Hugo theme. -- Responsive design -- Clean typography -- Google Analytics -- Lightbox -- Disqus +## Responsive design +Works on mobile, tablet and desktop. +## Responsive images +It generates several image sizes during build process and displays the best one for given device/resolution. +## Clean typography +It should be a pleasure to read your blog, right? +## Additional shortcodes +Shortcodes for Google Adsense, images, Speaker Deck, Video, Vimeo, Youtube. +## Google Adsense +You can use shortcode to insert Adsense Ad whenever you want. +## Google Analytics +Just add a Google Analytics code to turn it on. +## Lightbox +Image shortcode allow to turn on ([baguetteBox.js](https://feimosi.github.io/baguetteBox.js/) for given image. +## Auto hide/show header +This theme uses ([headroom.js](http://wicky.nillia.ms/headroom.js/)) script. +## Page scroll indicator +Displays progress bar on the top of the page when user scroll the page. +## Disqus +Just add a Disqus shortname to enable comments. +## Categories +Separate page with list of all categories and list of posts for selected category. +## Tags +Separate page with list of all categories and list of posts for selected tag. +## RSS +Custom RSS template without e-mail inside feed. +## Social icons +Add an information about your social profile in config file to display it on the home page. Supported services: email, Facebook, Github, Google+, Linkedin, Messenger, Spotify, Stackoverflow, Telegram, Twitter. +## Gravatar support +Just add your Gravatar email to the config file to display your avatar on the home page. +## and more - OpenGraph support - Schema Structured Data - Twitter card -- Creative commons licence icon in footer (optional) +- Display licence in footer - No JS frameworks, no CSS frameworks, no jQuery # Demo -You can preview this theme on my personal blog - [eshlox.net](https://eshlox.net). +You can preview this theme on my personal blog - [eshlox.net](https://eshlox.net) or [eshlox.pl](https://eshlox.pl). ## Table of Contents @@ -50,22 +76,36 @@ That's how the structure looks like: exampleSite/ ├── config.toml ├── content +│ ├── _index.md │ ├── categories │ │ └── _index.md -│ ├── _index.md +│ ├── media +│ │ ├── _index.md +│ │ ├── image-1.jpg +│ │ └── video.mp4 +│ ├── photos.md │ ├── posts +│ │ ├── 2014 +│ │ │ ├── creating-a-new-theme.md +│ │ │ ├── goisforlovers.md +│ │ │ ├── hugoisforlovers.md +│ │ │ └── migrate-from-jekyll.md │ │ ├── 2016 │ │ │ └── lorem-ipsum.md │ │ ├── 2017 │ │ │ ├── images.md │ │ │ └── typography.md │ │ └── _index.md +│ ├── projects.md │ └── tags │ └── _index.md -├── public -└── static - └── images - └── image-1.jpg +└── resources + └── _gen + └── images + └── media + ├── image-1_hu3d03a01dcc18bc5be0e67db3d8d209a6_1073788_320x0_resize_q75_box.jpg + ├── image-1_hu3d03a01dcc18bc5be0e67db3d8d209a6_1073788_480x0_resize_q75_box.jpg + └── image-1_hu3d03a01dcc18bc5be0e67db3d8d209a6_1073788_768x0_resize_q75_box.jpg ``` Every `_index.md` file contains title, language and slug. @@ -76,25 +116,49 @@ Copy `config.toml` from `exampleSite` to the root directory of your Hugo site an ### favicons -This theme contains default favicon with `S` letter. If you want to change it, create a directory `static/assets/img` inside the root of your Hugo site and put your favicon files there. They shoud have names: `favicon.ico` and `apple-touch-icon.png`. +This theme contains default favicon with `S` letter. If you want to change it, create a directory `static/assets/img` inside the root of your Hugo site and put your favicon files there. They should have names: `favicon.ico` and `apple-touch-icon.png`. ## Shortcodes This theme includes additional shortcodes. -### figure +### Adsense -Use [figure](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/figure) to embed an image. +Add adsense configuration and use `{{< adsense >}}` in your post to display an ad. -``` -{{< figure src="/images/image-1.jpg" title="Photo" >}} -``` +### Image -You can also use lightbox plugin to display image in full-screen mode ([baguetteBox.js](https://github.com/feimosi/baguetteBox.js)). +Insert responsive image with title: -``` -{{< figure src="/images/image-1.jpg" title="Photo" lightbox="true" >}} -``` +`{{< image src="media/image-1.jpg" title="Photo by Ales Krivec on Unsplash" >}}` + +Full page width image: + +`{{< image src="media/image-1.jpg" title="Photo by Ales Krivec on Unsplash" full="true">}}` + +Lightbox: + +`{{< image src="media/image-1.jpg" lightbox="true" >}}` + +Insert image without resizing (the same image for all devices/resulotions). + +`{{< image src="media/image-1.jpg" resize="false" >}}` + +### Speakcer Deck + +`{{< speakerdeck 50021f75cf1db900020005e7 >}}` + +### Video + +`{{< video src="media/video.mp4" >}}` + +### Responsive Vimeo + +`{{< vimeo 265143954 >}}` + +### Responsive Youtube + +`{{< vimeo 265143954 >}}` ## Development @@ -106,12 +170,11 @@ To review your changes, you can use `npm run start` command which will run `hugo ## Browsers support -Theme uses [HTML5 grid](https://caniuse.com/#feat=css-grid). - Dekstop: - Firefox (latest) - Chrome (latest) +- Safari (latest) Mobile: |