blob: efc39560b27915e1f523c4ae090418a6d0c5858f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
# Inkblotty
Inkblotty is a Hugo theme based on [Inkblot](https://github.com/mgsisk/inkblot).
[Demo](https://hugo-theme-inkblotty.netlify.com)
## Features
- Responsive Design
- Article
- Share Button (Facebook, Twitter, Hatena Bookmark)
- Comment form (Disqus)
- Related Posts
- Table of Contents by shortcode
- Article list
- Summarize and Readmore
- Sidebar
- Category list
- Tag cloud
- Recent Posts
- Archives
- Others
- Google Analytics
- Sitemap XML
- RSS
- Opengraph / Twitter Card
## Installation
1. Put theme directory into `themes` of your hugo site.
- Run git command in `themes` directory:
```
git clone https://github.com/tosi29/inkblotty.git
```
- Or, download and extract [zip file](https://github.com/tosi29/inkblotty/archive/master.zip), and put directory into `themes` directory as `inkblotty`.
2. Edit `config.toml` of your hugo site.
## Configuration
### Sample configuration file
[exampleSite/config.toml](https://github.com/tosi29/inkblotty/blob/master/exampleSite/config.toml) is for reference.
### Table of Contents
This theme has shortcode to create Table of Contents.
To insert Table of Contents, write the following code in markdown.
```
{{< toc >}}
```
This is sample configuration of TOC in `config.toml`
```
[markup]
[markup.tableOfContents]
startLevel = 1
endLevel = 3
ordered = false
```
If you set `startLevel = 2`, `<h1>` tag is ignored.
### Favicon
Put `favicon.ico` file in `static` directory to set favicon.
|
