Welcome to mirror list, hosted at ThFree Co, Russian Federation.

README.md - github.com/softwareyoga/ronu-hugo-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 8c7663556c3d6eccfa67e5200949b3582fcd10ae (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# Ronu Hugo Theme
Ronu is a clean and simple responsive theme for [hugo](https://gohugo.io). It simplicity lies in the fact that there is complete separation of html content and css classes.

Live demo at: [softwareyoga.com](https://www.softwareyoga.com)

No more of messy html like this that is full of css classes...

```html
<html>
<body>
	<div class="w3-row-padding w3-container">
		<div class="w3-col l3 m2">
			<h1>Blog</h1>
		</div>
		<div class="w3-col l6 m8">
			<h2 class="w3-center w3-bold">Post Title</h2>
		</div>  
	</body>
</html>
```

Instead, you will have beautifully formatted plain html without having to specify any css classes, thanks to [Sakura](https://oxal.org/projects/sakura) - A classless css framework.

```html
<html>
	<body>
		<h1>Blog</h1>
		<h2>Post Title></h2>
		<p>Content follows...
	</body>
</html>
```

The uncluttered user interface (and clean code) make it a delight to work with, focussing on the most important aspect - The Content.

![Ronu screenshot](https://github.com/softwareyoga/ronu-hugo-theme/blob/master/images/screenshot.png)


## Installation

### Requirements

- Hugo 0.64.1 or higher (extended version because of usage of sass)

### Standard Installation

To install Ronu as your default theme, first install this repository in the `themes/` directory:

```
    $ cd themes/
    $ git clone https://github.com/softwareyoga/ronu-hugo-theme
```

Second, specify `ronu` as your default theme in the `config.toml` file. Just add the line

```
    theme = "ronu"
```

at the top of the file.

## Base configuration

First include the following configuration in the config file: 

```toml
# Site settings
baseURL = "https://www.example.com/"
languageCode = "en-us"
title = "MySiteTitle"
theme = "ronu"
```

## Options

Ronu includes some customizable options, applied via the config file.


### Menu

Create a list of menu item links in the nav bar by assigning "menu.main" in the front matter, like so:

```toml
theme = "ronu"

[[menu.main]]
	name = "Blog"
	url = "/blog/"

[[menu.main]]
	name = "About"
	url = "/about/"
```

### Social
Inform your audience about your social presense in the footer, like so:

```toml
theme = "ronu"

[params]
	authorNname = "Your Name"
	twitterURL = "https://twitter.com/FooBar"
	linkedinURL = "https://www.linkedin.com/in/FooBar"
	email = "foobar@foobar.com"
```

### Main section and siteDescription

By default Ronu assumes the section with most pages as the main section. This is configurable, like so:

```toml
mainSections = ["post"]
```

'siteDescription' is used in the meta info headers in the generated html, configurable as:
```toml
siteDescription = "Your awesome site description"
```

### Theme colours

Ronu ships with 3 optional colour schemes based on [Sakura color scheme](https://github.com/oxalorg/sakura/tree/master/scss). To apply a particular colour, change the variables in 'style-in-use.scss'.

Reference values for the 3 built in colour options are specified in the files 'sakura-dark.scss', 'sakura-vader.scss' and 'sakura-white.scss'

To create your own theme, look to the file 'style-in-use.scss' and change the provided colors.

![Ronu in dark mode](https://github.com/softwareyoga/ronu-hugo-theme/blob/master/images/screenshot-dark.png)
![Ronu in vader mode](https://github.com/softwareyoga/ronu-hugo-theme/blob/master/images/screenshot-vader.png)

## Google Analytics

Google Analytics can be enabled by assigning your tracking code to the `googleAnalytics` variable in the config file:

```toml
googleAnalytics = "Your tracking code"
```

## Author
**Deepak Karanth**
* https://github.com/softwareyoga
* https://www.softwareyoga.com

## Contributing

Contributions are welcome and I will review and consider pull requests.  
Primary goals are:

- Keep it simple. (E.g. Do not add Disqus commenting as readability is the main aspect of this theme, not bells and whistles)
- Keep minimal (or zero) default configuration.
- Avoid interference of content with user-defined layouts.
- Avoid using JS

## License

Open sourced under the [MIT license](LICENSE.md).