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

github.com/Vimux/mainroad.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvimux <vimux@protonmail.com>2019-11-01 17:20:39 +0300
committervimux <vimux@protonmail.com>2019-11-01 17:20:39 +0300
commit7a89c0b7f3f8ed9a7dd713f86b1471f5c0f59ceb (patch)
treebf3fdce3a1b7ca73bdd069457ef50a271cbf19bc /README.md
parent0308645ca44fd675be773b741dfa012843c3ec58 (diff)
Update README.md: max line length <= 120
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 34 insertions, 11 deletions
diff --git a/README.md b/README.md
index 9921723..f8559d0 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
# Mainroad
-**Mainroad** is a responsive, simple, clean and content-focused [Hugo](https://gohugo.io/) theme based on the [MH Magazine lite](https://wordpress.org/themes/mh-magazine-lite/) WordPress theme by [MH Themes](https://www.mhthemes.com/).
+**Mainroad** is a responsive, simple, clean and content-focused [Hugo](https://gohugo.io/) theme based on the
+[MH Magazine lite](https://wordpress.org/themes/mh-magazine-lite/) WordPress theme by
+[MH Themes](https://www.mhthemes.com/).
-**[Demo (Fast update)](https://hugothemes.gitlab.io/mainroad/)** | [Standart Demo](https://themes.gohugo.io/theme/mainroad/)
+**[Demo (Fast update)](https://hugothemes.gitlab.io/mainroad/)** |
+[Standart Demo](https://themes.gohugo.io/theme/mainroad/)
![screenshot](https://github.com/Vimux/mainroad/blob/master/images/screenshot.png)
@@ -12,7 +15,8 @@
+ Responsive menu
+ Secondary menus
+ SVG icons
-+ Theme options (Sidebar position, Author Box, Post Navigation, highlight color) available through config.toml file parameters
++ Theme options (Sidebar position, Author Box, Post Navigation, highlight color) available through config.toml file
+parameters
+ Table of Contents
+ MathJax
@@ -25,7 +29,10 @@ Other browsers (like Opera on Blink engine) are also supported, but not tested.
## Installation
-*Before starting, please be sure that you have [installed Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and [created a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). After that, you ready to install **Mainroad**.*
+*Before starting, please be sure that you have
+[installed Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and
+[created a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). After that, you ready to
+install **Mainroad**.*
In your Hugo site `themes` directory, run:
@@ -105,7 +112,8 @@ googleAnalytics = "" # Enable Google Analytics by entering your tracking id
A good idea is not to copy all these settings without understanding how it works.
-For more information about all available standard configuration settings, please read [Configure Hugo: All Configuration Settings](https://gohugo.io/getting-started/configuration/#all-configuration-settings).
+For more information about all available standard configuration settings, please read
+[All Hugo Configuration Settings](https://gohugo.io/getting-started/configuration/#all-configuration-settings).
### Front Matter example
@@ -130,25 +138,40 @@ menu: main # Optional, add page to a menu. Options: main, side, footer
---
```
-For more information about front matter variables read [Hugo Front Matter](https://gohugo.io/themes/installing-and-using-themes/) from Hugo official documentation.
+For more information about front matter variables read
+[Hugo Front Matter](https://gohugo.io/themes/installing-and-using-themes/) from Hugo official documentation.
### Sidebar
-**Mainroad** comes with a configurable sidebar that can be on the left, on the right, or disabled. The default layout can be specified in the `[Params.sidebar]` section of the configuration. The position can be specified for home, list and single pages individually. Use the keys `home`, `list` and `single` with values `"left"`, `"right"` or `false`. The layout can be configured per page, by setting the `sidebar` parameter with one of the same values in the page's front matter.
+**Mainroad** comes with a configurable sidebar that can be on the left, on the right, or disabled. The default layout
+can be specified in the `[Params.sidebar]` section of the configuration. The position can be specified for home, list
+and single pages individually. Use the keys `home`, `list` and `single` with values `"left"`, `"right"` or `false`. The
+layout can be configured per page, by setting the `sidebar` parameter with one of the same values in the page's front
+matter.
-The sidebar consists of multiple widgets. Widgets can be enabled individually using the `widgets` key with a list of widget names as value. You can add your own widgets, by placing a template under `layouts/partials/widgets/<name>.html`. The list of widgets can be overwritten from a page's front matter.
+The sidebar consists of multiple widgets. Widgets can be enabled individually using the `widgets` key with a list of
+widget names as value. You can add your own widgets, by placing a template under `layouts/partials/widgets/<name>.html`.
+The list of widgets can be overwritten from a page's front matter.
-Some widget respect optional configuration. Have a look at the `[Params.widgets]` and `[Params.widgets.social]` sections in the example configuration above.
+Some widget respect optional configuration. Have a look at the `[Params.widgets]` and `[Params.widgets.social]` sections
+in the example configuration above.
### Menus
-**Mainroad** supports multiple menus. The `main` menu is fully responsive and displayed right under the site header. The secondary menus `side` and `footer` are displayed in a sidebar widget and the page footer. In order to add a page to a menu, add a `menu = <menu>` parameter to the pages frontmatter. You can also add a page to many menus by providing a list, e.g. `menu = [main, side, footer]`. Don't forget to enable the `sidemenu` widget in the widget configuration if you want to use the `side` menu.
+**Mainroad** supports multiple menus. The `main` menu is fully responsive and displayed right under the site header. The
+secondary menus `side` and `footer` are displayed in a sidebar widget and the page footer. In order to add a page to a
+menu, add a `menu = <menu>` parameter to the pages frontmatter. You can also add a page to many menus by providing a
+list, e.g. `menu = [main, side, footer]`. Don't forget to enable the `sidemenu` widget in the widget configuration if
+you want to use the `side` menu.
**Sidenote:** Please keep in mind that Mainroad menus don't support nested items (submenus).
## Contributing
-Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/Vimux/mainroad/issues) to let me know. Or make directly a [pull request](https://github.com/Vimux/mainroad/pulls), but please respect the following [contributing guide](https://github.com/Vimux/mainroad/blob/master/CONTRIBUTING.md).
+Have you found a bug or got an idea for a new feature? Feel free to use the
+[issue tracker](https://github.com/Vimux/mainroad/issues) to let me know. Or make directly a
+[pull request](https://github.com/Vimux/mainroad/pulls), but please respect the following
+[contributing guide](https://github.com/Vimux/mainroad/blob/master/CONTRIBUTING.md).
## License