Skip to content

Commit a78fdc3

Browse files
committed
Update Readme with adminition shortcodes
1 parent 37ee02a commit a78fdc3

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Hermit is a minimal and fast theme for Hugo. It's built for bloggers who want a
1515
* Extremely lightweight and load fast. No third party framework, no unnecessary code.
1616
* All code fields feature syntax highlighting and a code-copy function
1717
* 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.
18+
* Admonition shortcodes for note, tip and warning to highlight parts of a blog post
1819

1920
**[Theme Demo](https://hugo-theme-hermit.netlify.com/)** (uses contents and config from the `exampleSite` folder)
2021

@@ -73,6 +74,18 @@ The following icons are supported, please make sure the `name` filed is exactly
7374

7475
If that's not enough, you can see [Overriding templates](#overriding-templates) section.
7576

77+
#### Admonition Shortcodes
78+
79+
Shortcodes are available for note, tip and warning.
80+
81+
```md
82+
{{% note %}}
83+
This will be shown in a box with to highlight a note.
84+
{{% /note %}}
85+
```
86+
87+
See the [shortcode docs](https://gohugo.io/content-management/shortcodes/) from hugo.
88+
7689
### Manage content
7790

7891
* Keep your regular pages in the `content` folder. To create a new page, run `hugo new page-title.md`
@@ -85,12 +98,15 @@ If that's not enough, you can see [Overriding templates](#overriding-templates)
8598
In Hugo, layouts can live in either the project’s (root) or the themes’ layout folders, any template inside the root layout folder will override theme's layout that relative to it, for example: `layouts/_default/baseof.html` will override `themes/hermit/layouts/_default/baseof.html`. So, you can easily customize the theme without edit it directly, which makes updating the theme easier. Here's some common customizations:
8699

87100
##### Customize social icons
101+
88102
You can modify or add any svg icons in site's `layouts/partials/svg.html`.
89103

90104
##### Customize comment system
105+
91106
We only have built-in support for Disqus at the moment, if that doesn't fit your needs, you can just add html to site's `layouts/partials/comments.html`.
92107

93108
##### Add custom analytics
109+
94110
If you prefer to use different analytics system other than google analytics, then add them inside `layouts/partials/analytics.html`.
95111

96112
#### Customize CSS

0 commit comments

Comments
 (0)