forked from mirror/Mainroad
change more thigns from mainroad to roadster
This commit is contained in:
Mansoor Barri
parent
bfbf7c9a58
commit
e9c796e34f
4 changed files with 40 additions and 40 deletions
examplesite/content/docs
|
|
@ -1,4 +1,4 @@
|
|||
---
|
||||
title: Documentation
|
||||
description: Mainroad theme documentation, including getting started, customization guides, and FAQ.
|
||||
description: Roadster theme documentation, including getting started, customization guides, and FAQ.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
title: Customization
|
||||
description: Describes common Mainroad theme configuration parameters that can be adjusted via config file or via Front
|
||||
description: Describes common Roadster theme configuration parameters that can be adjusted via config file or via Front
|
||||
Matter section.
|
||||
lead: Describes common Mainroad theme configuration parameters that can be adjusted via config file or via Front Matter
|
||||
lead: Describes common Roadster theme configuration parameters that can be adjusted via config file or via Front Matter
|
||||
section.
|
||||
date: 2022-01-24T14:00:00.000Z
|
||||
date: 2025-01-06
|
||||
thumbnail:
|
||||
src: "img/placeholder.png"
|
||||
visibility:
|
||||
|
|
@ -16,7 +16,7 @@ weight: 2
|
|||
menu: main
|
||||
---
|
||||
|
||||
Customization page describes common Mainroad configuration parameters which can be specified via configuration file or
|
||||
Customization page describes common Roadster configuration parameters which can be specified via configuration file or
|
||||
via Front Matter section. That includes logo section tuning, adding a sidebar with widgets, adjusting highlight color,
|
||||
and more.
|
||||
|
||||
|
|
@ -27,13 +27,13 @@ there's a good chance it is covered somewhere in [Hugo docs](https://gohugo.io/d
|
|||
|
||||
### Logo
|
||||
|
||||
**Mainroad** allows you to set a custom logo in the site header. You may use text, or image, or both. Use the following
|
||||
**Roadster** allows you to set a custom logo in the site header. You may use text, or image, or both. Use the following
|
||||
options in your site config:
|
||||
|
||||
```toml
|
||||
[Params.logo]
|
||||
image = "img/placeholder.png"
|
||||
title = "Mainroad"
|
||||
title = "Roadster"
|
||||
subtitle = "Just another site"
|
||||
```
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ Disable it this way:
|
|||
|
||||
### Highlight color
|
||||
|
||||
Mainroad uses `#e22d30` as a default highlight color, but you may choose and set any other color.
|
||||
Roadster uses `#e22d30` as a default highlight color, but you may choose and set any other color.
|
||||
|
||||
```toml
|
||||
[Params.style.vars]
|
||||
|
|
@ -117,7 +117,7 @@ This page is an example of list-only thumbnail visibility.
|
|||
|
||||
### Sidebar
|
||||
|
||||
**Mainroad** comes with a configurable sidebar that can be on the left, on the right, or disabled. The default layout
|
||||
**Roadster** 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`.
|
||||
|
||||
|
|
@ -228,7 +228,7 @@ generation), then it should not be cached. Always check that your modified/custo
|
|||
|
||||
### Social Widget: custom links
|
||||
|
||||
**Mainroad** contains built-in social links in the social widget. In addition to default social links, you may set
|
||||
**Roadster** contains built-in social links in the social widget. In addition to default social links, you may set
|
||||
custom links by adding `Params.widgets.social.custom` to your `config.toml`. Here is an example:
|
||||
|
||||
```toml
|
||||
|
|
@ -272,7 +272,7 @@ You can also specify the `rel` attribute for the link. By default, the attribute
|
|||
|
||||
### Search box widget
|
||||
|
||||
The search box widget can refer to the results of Google, Bing, and DuckDuckGo searches. By default, Mainroad uses
|
||||
The search box widget can refer to the results of Google, Bing, and DuckDuckGo searches. By default, Roadster uses
|
||||
Google search if no additional configuration options are specified.
|
||||
|
||||
To use a different search engine, first of all, check that the search widget is enabled. Then set the search parameters
|
||||
|
|
@ -320,11 +320,11 @@ To use a different search engine, first of all, check that the search widget is
|
|||
|
||||
Note that Google PSE requires additional steps to work correctly.
|
||||
See [Creating a Programmable Search Engine](https://developers.google.com/custom-search/docs/tutorial/creatingcse) and
|
||||
especially our [FAQ]({{< relref "/docs/faq.md" >}} "Mainroad FAQ") for more instructions.
|
||||
especially our [FAQ]({{< relref "/docs/faq.md" >}} "Roadster FAQ") for more instructions.
|
||||
|
||||
### Menus
|
||||
|
||||
**Mainroad** supports multiple menus. The `main` menu is fully responsive and displayed right under the site header. The
|
||||
**Roadster** 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 respectively. To add a page to
|
||||
a menu, add a `menu: <menu>` parameter to the page's front matter:
|
||||
|
||||
|
|
@ -347,13 +347,13 @@ menu:
|
|||
- footer
|
||||
```
|
||||
|
||||
**Note:** Please keep in mind that Mainroad menus don't support nested items i.e. submenus.
|
||||
**Note:** Please keep in mind that Roadster menus don't support nested items i.e. submenus.
|
||||
|
||||
See [Menus](https://gohugo.io/content-management/menus/#readout) from official Hugo documentation for more info.
|
||||
|
||||
### Custom Google Fonts support
|
||||
|
||||
Mainroad uses Open Sans from Google Fonts as a main font. But you can use any other font from Google Fonts if you'd
|
||||
Roadster uses Open Sans from Google Fonts as a main font. But you can use any other font from Google Fonts if you'd
|
||||
like. Beware, in most cases, such changes require manual CSS adjustment because every set of fonts is different and
|
||||
might not look as good as our default font.
|
||||
|
||||
|
|
@ -402,4 +402,4 @@ It is possible to disable Google Fonts and use system font stack instead.
|
|||
fontFamilySecondary = "SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace"
|
||||
```
|
||||
|
||||
[Edit this page on GitHub](https://github.com/vimux/mainroad/blob/master/exampleSite/content/docs/customization.md)
|
||||
[Edit this page on GitHub](https://github.com/mansoorbarri/Roadster/blob/master/exampleSite/content/docs/customization.md)
|
||||
|
|
|
|||
|
|
@ -24,16 +24,16 @@ The answers have been categorized into two groups:
|
|||
|
||||
## General questions
|
||||
|
||||
### Do I need to have prior experience before proceeding with the Mainroad theme?
|
||||
### Do I need to have prior experience before proceeding with the Roadster theme?
|
||||
|
||||
**Yes.** You'll need to be familiar with Hugo before proceeding.
|
||||
[Our docs section]({{< ref "/docs/_index.md" >}} "Mainroad theme documentation") is intended for intermediate to
|
||||
[Our docs section]({{< ref "/docs/_index.md" >}} "Roadster theme documentation") is intended for intermediate to
|
||||
advanced users and developers. Our documentation may still be helpful to users with minimal experience, but are not
|
||||
comprehensive.
|
||||
|
||||
### Do I need to use the extended version of Hugo?
|
||||
|
||||
**No.** Mainroad theme intentionally does not use any features of the extended version. As such, the extended version of
|
||||
**No.** Roadster theme intentionally does not use any features of the extended version. As such, the extended version of
|
||||
Hugo is not required (but applicable).
|
||||
|
||||
### Is there a list of all possible configuration options?
|
||||
|
|
@ -42,20 +42,20 @@ Hugo is not required (but applicable).
|
|||
|
||||
* See [All Configuration Settings](https://gohugo.io/getting-started/configuration/#all-configuration-settings)
|
||||
for the full list of Hugo-defined variables with their default values.
|
||||
* See [Mainroad config.toml example](https://github.com/Vimux/Mainroad#configtoml-example) for the full list of
|
||||
Mainroad-specific variables.
|
||||
* See [Roadster config.toml example](https://github.com/mansoorbarri/Roadster#configtoml-example) for the full list of
|
||||
Roadster-specific variables.
|
||||
|
||||
**Front Matter:**
|
||||
|
||||
* See [Front Matter Variables](https://gohugo.io/content-management/front-matter#front-matter-variables) for the
|
||||
list of Hugo-defined Front Matter variables.
|
||||
* See [Mainroad Front Matter example](https://github.com/Vimux/Mainroad#front-matter-example) for the list of
|
||||
Mainroad-specific Front Matter variables.
|
||||
* See [Roadster Front Matter example](https://github.com/mansoorbarri/Roadster#front-matter-example) for the list of
|
||||
Roadster-specific Front Matter variables.
|
||||
|
||||
### What if I have more questions? Should I create an issue?
|
||||
|
||||
**We don't provide personal technical support.** As stated in our
|
||||
[contributing guidelines](https://github.com/Vimux/Mainroad/blob/master/CONTRIBUTING.md), please do not use the issue
|
||||
[contributing guidelines](https://github.com/mansoorbarri/Roadster/blob/master/CONTRIBUTING.md), please do not use the issue
|
||||
tracker for personal support. This includes reports like: “How do I do this", “Everything is broken; help me”, “I
|
||||
changed something, and it doesn't work anymore”, “It's not a personal issue, but I just want to ask how X or Y works”,
|
||||
“I forked your theme, then something broke; fix this immediately”, and so on.
|
||||
|
|
@ -70,8 +70,8 @@ contributing rules**. All other issues will be closed and marked as invalid.
|
|||
There is no way to do this on the fly with Hugo, but you can use the one-liners below with some preparations:
|
||||
|
||||
1. Copy:
|
||||
* `./themes/mainroad/static/favicon.ico` to `./static/favicon.ico`
|
||||
* `./themes/mainroad/static/apple-touch-icon.png` to `./static/apple-touch-icon.png`
|
||||
* `./themes/roadster/static/favicon.ico` to `./static/favicon.ico`
|
||||
* `./themes/roadster/static/apple-touch-icon.png` to `./static/apple-touch-icon.png`
|
||||
1. At the beginning of each script, replace the color in the variable with your preferred color. You must use
|
||||
six-digit hex triplet notation (e.g., `#E22D30`) to make it work properly.
|
||||
|
||||
|
|
@ -129,4 +129,4 @@ required.
|
|||
Google PSE (CSE) should work when it's done. Look and feel will be far from perfect, but you have to solve this problem
|
||||
with [Google PSE Control Panel](https://programmablesearchengine.google.com/controlpanel/all) and additional CSS.
|
||||
|
||||
[Edit this page on GitHub](https://github.com/vimux/mainroad/blob/master/exampleSite/content/docs/faq.md)
|
||||
[Edit this page on GitHub](https://github.com/mansoorbarri/Roadster/blob/master/exampleSite/content/docs/faq.md)
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: Getting started
|
||||
description: This article helps you get started with the Mainroad theme, including installation and minimal
|
||||
description: This article helps you get started with the Roaster theme, including installation and minimal
|
||||
configuration.
|
||||
lead: This article helps you get started with the Mainroad theme, including installation and minimal configuration.
|
||||
lead: This article helps you get started with the Roadster theme, including installation and minimal configuration.
|
||||
date: 2022-01-24T14:00:00.000Z
|
||||
tags:
|
||||
- "Installation"
|
||||
|
|
@ -13,7 +13,7 @@ weight: 1
|
|||
menu: main
|
||||
---
|
||||
|
||||
Welcome to the Mainroad theme documentation. This quick start guide covers Mainroad theme installation and minimal
|
||||
Welcome to the Roadster theme documentation. This quick start guide covers Roadster theme installation and minimal
|
||||
configuration and is intended for intermediate to advanced users. To understand this guide, you need to be familiar
|
||||
with the [Hugo](https://gohugo.io/) static site generator.
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ with the [Hugo](https://gohugo.io/) static site generator.
|
|||
|
||||
## Installation
|
||||
|
||||
Before installing the **Mainroad** theme, make sure that you've
|
||||
Before installing the **Roadster** theme, make sure that you've
|
||||
[installed **Hugo** (version 0.54.0 or later)](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). To learn how to install
|
||||
Hugo, visit [Hugo Documentation](https://gohugo.io/getting-started/installing/).
|
||||
|
|
@ -38,7 +38,7 @@ If you don't plan to make significant changes to the theme but still want to tra
|
|||
your Hugo site:
|
||||
|
||||
```sh
|
||||
git submodule add https://github.com/mansoorbarri/mainroad-v2.git themes/mainroad
|
||||
git submodule add https://github.com/mansoorbarri/Roadster-v2.git themes/roadster
|
||||
```
|
||||
|
||||
**Note:**
|
||||
|
|
@ -52,13 +52,13 @@ instead of git clone.
|
|||
Run this [git clone](https://git-scm.com/docs/git-clone) command from the root of your Hugo site:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/mansoorbarri/mainroad-v2.git themes/mainroad
|
||||
git clone https://github.com/mansoorbarri/Roadster-v2.git themes/roadster
|
||||
```
|
||||
|
||||
### Option C: Manual install
|
||||
|
||||
If you do not want to use git, you can manually
|
||||
**[download ZIP](https://github.com/mansoorbarri/mainroad-v2/archive/master.zip)** and extract it into the `themes/mainroad`
|
||||
**[download ZIP](https://github.com/mansoorbarri/Roadster-v2/archive/master.zip)** and extract it into the `themes/roadster`
|
||||
within your Hugo site.
|
||||
|
||||
---
|
||||
|
|
@ -68,19 +68,19 @@ within your Hugo site.
|
|||
Whichever installation option you choose, don't forget to edit `theme` param of the site configuration `config.toml`:
|
||||
|
||||
```toml
|
||||
theme = "mainroad"
|
||||
theme = "Roadster"
|
||||
```
|
||||
|
||||
To check it out, build the site via `hugo` command or make it available on a local server via `hugo server`.
|
||||
|
||||
## Minimal configuration
|
||||
|
||||
**Do not copy the [example config](https://github.com/mansoorbarri/mainroad-v2#configtoml-example) as-is.**
|
||||
Use only the parameters that you need. The Mainroad theme contains required defaults, so you don't need to add all of
|
||||
**Do not copy the [example config](https://github.com/mansoorbarri/Roadster-v2#configtoml-example) as-is.**
|
||||
Use only the parameters that you need. The Roadster theme contains required defaults, so you don't need to add all of
|
||||
the configuration parameters to run the theme for the first time. Before adding any theme-specific parameters, make
|
||||
sure to edit the `theme` param inside the config file and check that the theme works.
|
||||
|
||||
For information about common customization settings, see [Customization page]({{< relref "/docs/customization.md" >}} "Mainroad theme customization").
|
||||
To view our example configuration, visit [demo config](https://github.com/mansoorbarri/mainroad-v2/blob/master/exampleSite/config.toml).
|
||||
For information about common customization settings, see [Customization page]({{< relref "/docs/customization.md" >}} "Roadster theme customization").
|
||||
To view our example configuration, visit [demo config](https://github.com/mansoorbarri/Roadster-v2/blob/master/exampleSite/config.toml).
|
||||
|
||||
[Edit this page on GitHub](https://github.com/mansoorbarri/mainroad-v2/blob/master/exampleSite/content/docs/getting-started.md)
|
||||
[Edit this page on GitHub](https://github.com/mansoorbarri/Roadster-v2/blob/master/exampleSite/content/docs/getting-started.md)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue