27
0
Fork 1
forked from mirror/Mainroad

Merge pull request from stoic-hugo/patch-1

Update getting-started.md
This commit is contained in:
Mansoor Barri 2025-01-11 12:32:40 +00:00 committed by GitHub
commit 6576da678c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -13,37 +13,28 @@ weight: 1
menu: main
---
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.
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.
<!--more-->
## Installation
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/).
Before installing the **Roadster** theme, make sure that you've [installed **Hugo** (version 0.128.0 or later)](https://gohugo.io/getting-started/installing/) and [created a new site](https://gohugo.io/getting-started/quick-start/#create-a-site).
There are a few ways to install a theme in Hugo. This can be done via git submodule, git clone, Hugo modules, or
by downloading the archive and manually copying the files. Three installation options are described below.
There are a few ways to install a theme in Hugo. This can be done via git submodule, git clone, Hugo modules, or by downloading the archive and manually copying the files. Three installation options are described below.
### Option A: `git submodule`
*Additional requirements: git*
If you don't plan to make significant changes to the theme but still want to track and update it, you can add it as a
[git submodule](https://git-scm.com/docs/git-submodule) by running the following command from the root directory of
your Hugo site:
If you don't plan to make significant changes to the theme but still want to track and update it, you can add it as a [git submodule](https://git-scm.com/docs/git-submodule) by running the following command from the root directory of your Hugo site:
```sh
git submodule add https://github.com/mansoorbarri/Roadster.git themes/roadster
```
**Note:**
[Netlify expects git submodule](https://docs.netlify.com/configure-builds/common-configurations/hugo/#hugo-themes)
instead of git clone.
[Netlify expects git submodule](https://docs.netlify.com/configure-builds/common-configurations/hugo/#hugo-themes) instead of git clone.
### Option B: `git clone`
@ -57,9 +48,7 @@ git clone https://github.com/mansoorbarri/Roadster.git themes/roadster
### Option C: Manual install
If you do not want to use git, you can manually
**[download ZIP](https://github.com/mansoorbarri/Roadster/archive/master.zip)** and extract it into the `themes/roadster`
within your Hugo site.
If you do not want to use git, you can manually **[download ZIP](https://github.com/mansoorbarri/Roadster/archive/master.zip)** and extract it into the `themes/roadster` within your Hugo site.
---
@ -75,12 +64,8 @@ To check it out, build the site via `hugo` command or make it available on a loc
## Minimal configuration
**Do not copy the [example config](https://roadster-hugo.pages.dev/docs/customization/#configuration-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.
**Do not copy the [example config](https://roadster-hugo.pages.dev/docs/customization/#configuration-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" >}} "Roadster theme customization").
To view our example configuration, visit [demo config](https://github.com/mansoorbarri/Roadster/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/blob/master/examplesite/config.toml).
[Edit this page on GitHub](https://github.com/mansoorbarri/Roadster/blob/master/examplesite/content/docs/getting-started.md)