diff options
author | Lisa <93638499+lisa005@users.noreply.github.com> | 2022-02-25 21:21:17 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-25 21:21:17 +0300 |
commit | 4f576258724f0af66c99db9aee1fdd5251e9587d (patch) | |
tree | 4addea3922d613b1b21db05661cb1f71c73e0315 | |
parent | b4baa56bd7a2187e6cfcd83ad126527ae92b1392 (diff) |
Update getting-started.md (#285)
Edits for grammar, clarity, and conciseness
-rw-r--r-- | exampleSite/content/docs/getting-started.md | 47 |
1 files changed, 22 insertions, 25 deletions
diff --git a/exampleSite/content/docs/getting-started.md b/exampleSite/content/docs/getting-started.md index 93c2c94..638383d 100644 --- a/exampleSite/content/docs/getting-started.md +++ b/exampleSite/content/docs/getting-started.md @@ -13,32 +13,29 @@ weight: 1 menu: main --- -Welcome to the Mainroad theme documentation. This quick guide has been written for intermediate and advanced users who -are interested in getting started with the Mainroad theme, including installation and minimal configuration. To fully -understand the rest of this guide, you need to be familiar with the main concepts of the [Hugo](https://gohugo.io/) -static site generator. +Welcome to the Mainroad theme documentation. This quick start guide covers Mainroad 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 -To begin with **Mainroad** theme, you should have -[**Hugo** (version 0.48 or later) installed](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and -[create a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). For comprehensive Hugo -installation guide, please visit [Hugo Documentation](https://gohugo.io/getting-started/installing/). After that, you -are ready to install Mainroad theme. +Before installing the **Mainroad** theme, make sure that you've +[installed **Hugo** (version 0.48 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/). -There are a few options to install a theme in Hugo. This can be done via git submodule, git clone, Hugo modules, or even -by downloading the archive and manually copying the files. Use what you know and what works best for you. 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 any significant changes but want to track and update the theme, 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/vimux/mainroad.git themes/mainroad @@ -60,7 +57,7 @@ git clone https://github.com/vimux/mainroad.git themes/mainroad ### Option C: Manual install -If you do not want to use git for some reason, you can manually +If you do not want to use git, you can manually **[download ZIP](https://github.com/vimux/mainroad/archive/master.zip)** and extract it into the `themes/mainroad` within your Hugo site. @@ -68,22 +65,22 @@ within your Hugo site. ### Activate theme -No matter what option do you choose above, don't forget to edit `theme` param of the site configuration `config.toml`: +Whichever installation option you choose, don't forget to edit `theme` param of the site configuration `config.toml`: ```toml theme = "mainroad" ``` -Done. Build the site via `hugo` command or make it available on a local server via `hugo server` to check it out. +To check it out, build the site via `hugo` command or make it available on a local server via `hugo server`. ## Minimal configuration -**We don't recommend copying [example config](https://github.com/vimux/mainroad#configtoml-example) as-is.** -Mainroad theme contains required defaults, so you don't need to add all of configuration parameters to run the -theme for the first time without errors from Hugo. Make sure that you edit the `theme` param inside the config file -and check that theme works. Only then start to add theme-specific parameters that you really need. -[Customization page]({{< relref "/docs/customization.md" >}} "Mainroad theme customization") describes common settings -that you may want to change and our [demo config](https://github.com/vimux/mainroad/blob/master/exampleSite/config.toml) -could help with configuration too. +**Do not copy the [example config](https://github.com/vimux/mainroad#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 +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/vimux/mainroad/blob/master/exampleSite/config.toml). [Edit this page on GitHub](https://github.com/vimux/mainroad/blob/master/exampleSite/content/docs/getting-started.md) |