You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@ Hermit is a minimal and fast theme for Hugo. It's built for bloggers who want a
15
15
* Extremely lightweight and load fast. No third party framework, no unnecessary code.
16
16
* All code fields feature syntax highlighting and a code-copy function
17
17
* 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
18
19
19
20
**[Theme Demo](https://hugo-theme-hermit.netlify.com/)** (uses contents and config from the `exampleSite` folder)
20
21
@@ -73,6 +74,18 @@ The following icons are supported, please make sure the `name` filed is exactly
73
74
74
75
If that's not enough, you can see [Overriding templates](#overriding-templates) section.
75
76
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
+
76
89
### Manage content
77
90
78
91
* 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)
85
98
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:
86
99
87
100
##### Customize social icons
101
+
88
102
You can modify or add any svg icons in site's `layouts/partials/svg.html`.
89
103
90
104
##### Customize comment system
105
+
91
106
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`.
92
107
93
108
##### Add custom analytics
109
+
94
110
If you prefer to use different analytics system other than google analytics, then add them inside `layouts/partials/analytics.html`.
0 commit comments