blob: 2e5f2bb4adfdcfb4e4c1ca5be7b5cd0f77e6d6ee (
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
![Sustain - Logo][logo]
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [With `git`](#with-git)
- [Manual](#manual)
- [Quick start](#quick-start)
- [Features](#features)
- [Syntax highlighting](#syntax-highlighting)
- [Disqus](#disqus)
- [Google Analytics](#google-analytics)
- [About](#about)
- [Contributing](#contributing)
- [License](#license)
********************
![Sustain Screen][screenshot]
********************
<p align="center"><b><a href="https://demo.nurlan.co/hugo-sustain/">Sustain Live Demo</a></b></p>
## Installation
#### With `git`
From the root of your Hugo site, clone the theme into `themes/hugo-sustain` by running :
```sh
git clone https://github.com/nurlansu/hugo-sustain.git themes/hugo-sustain
```
#### Manual
1. [Download][zip-archive] zip archive.
2. Unarchive it.
3. Move `hugo-sustain` folder in `themes` folder of your blog
For more information read the official [setup guide][hugo-guide] of Hugo.
## Quick start
After installation, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation.
```
exampleSite
├── config.toml
├── content
│ ├── projects.md
│ │
│ └── blog
│ ├── creating-a-new-theme.md
│ ├── go-is-for-lovers.md
│ ├── hugo-is-for-lovers.md
│ └── migrate-from-jekyll.md
│
├── data
│ └── projects.yml
│
└── static
```
Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
Hugo includes a development server, so you can view your changes as you go -
very handy. Spin it up with the following command:
```sh
hugo serve
```
Now you can go to [localhost:1313][local] and the Sustain
theme should be visible.
## Features
### Syntax highlighting
Use `highlight = true` in the front matter to include [`highlight.js`][highlight-js] javascript and css files.
### Disqus
To use this feature, uncomment and fill out the `disqusShortname` parameter in `config.toml`.
### Google Analytics
To add Google Analytics, simply sign up to [Google Analytics][g-analytics] to obtain your Google Tracking ID, and add this tracking ID to the `googleAnalytics` parameter in `config.toml`.
## About
This is a port of the Jekyll theme [Sustain][sustain-jekyll] by [Fábio Madeira][sustain-author]. It supports most of the features of the original theme.
## Contributing
Pull requests, bug fixes, and new features are welcome!
1. Fork the repository
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -a -m 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request on GitHub
## License
<p align="center">
<a href="./LICENSE.md"><img src="https://nurlan.co/cdn/logo.svg" width="100%" height="128"></a>
<a href="./LICENSE.md"><strong>MIT</strong></a>
</p>
[logo]: https://nurlan.co/cdn/sustain.png
[screenshot]: https://nurlan.co/cdn/sustain-screen.png
[bootstrap]: https://getbootstrap.com/
[hugo]: https://gohugo.io/
[gh-pages]: https://pages.github.com/
[zip-archive]: https://github.com/nurlansu/hugo-sustain/archive/master.zip
[hugo-guide]: https://gohugo.io/overview/installing/
[local]: http://localhost:1313/
[highlight-js]: https://highlightjs.org/
[g-analytics]: https://www.google.com/analytics/
[sustain-jekyll]: https://github.com/biomadeira/sustain/
[sustain-author]: https://github.com/biomadeira/
|
