blob: 3b7269d244bf4d4644c5d1dfefb629074486784b (
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
|
# Charaka (ಚರಕ)
Minimalistic and Responsive blog theme for hugo. Uses css framework [Bulma](https://bulma.io/).
## Getting Started
Clone this repository to your hugo theme directory.
```
mkdir themes
cd themes
git clone https://github.com/natarajmb/charaka-hugo-theme.git
```
## Configuration
Take a look in the [exampleSite](https://github.com/natarajmb/charaka-hugo-theme/tree/master/exampleSite) folder.
This directory contains an example config file and the content for the demo.
It serves as an example setup for your documentation.
Copy the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
__[config.toml](https://github.com/natarajmb/charaka-hugo-theme/blob/master/exampleSite/config.toml)__:
```toml
baseurl = "https://example.com"
languageCode = "en"
title = "Charaka"
theme = "charaka-hugo-theme"
copyright = "© <a href=\"https://github.com/natarajmb\">Nataraj Basappa</a> 2018"
disqusShortname = ""
googleAnalytics = ""
[params]
[params.highlight]
style = "zenburn"
[[params.social]]
url = "about.html"
fa_icon = "fas fa-info"
[[params.social]]
url = "https://github.com/natarajmb"
fa_icon = "fab fa-github"
[[params.social]]
url = "https://www.linkedin.com/in/natarajmb/"
fa_icon = "fab fa-linkedin-in"
[[params.social]]
url = "https://twitter.com/natarajmb"
fa_icon = "fab fa-twitter"
```
## Build
```
hugo server
```
You can go to localhost:1313 and this theme should be visible.
## Inspirations
- [Hemingway](https://themes.gohugo.io/hemingway/)
- [Journal](https://themes.gohugo.io/hugo-journal/)
- Apple iBooks colour scheme
## How to tweak
- Once you have activated the theme as above and running hugo in server mode
- Install [npm](https://www.npmjs.com/get-npm)
- Get inside checked-out theme directory and run `npm install`
- Make required changes to style.scss and run `npm run css-build && npm run css-watch` to live update your changes
## License
Charaka is licensed under the [MIT License](LICENSE.md).
## Author
[Nataraj Basappa](https://github.com/natarajmb)
|
