diff options
author | Lisa <93638499+lisa005@users.noreply.github.com> | 2022-02-25 21:24:59 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-25 21:24:59 +0300 |
commit | b3b48ada28f75cceb2f9ac17cabe5855b428e2b2 (patch) | |
tree | fbc0c14d5bbff5ec6ec4bdc5aa62fc7a96394b36 /exampleSite | |
parent | 4f576258724f0af66c99db9aee1fdd5251e9587d (diff) |
Update faq.md (#286)
Edits for overall tone, grammar, and conciseness
Diffstat (limited to 'exampleSite')
-rw-r--r-- | exampleSite/content/docs/faq.md | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/exampleSite/content/docs/faq.md b/exampleSite/content/docs/faq.md index 7203a44..bdb9030 100644 --- a/exampleSite/content/docs/faq.md +++ b/exampleSite/content/docs/faq.md @@ -12,7 +12,7 @@ menu: name: FAQ --- -Browse this FAQ page to find a collection of answers to frequently asked questions that have not been covered elsewhere +Browse this FAQ page to find answers to frequently asked questions that have not been covered elsewhere in the documentation. <!--more--> @@ -24,12 +24,12 @@ The answers have been categorized into two groups: ## General questions -### Do I need to have some prior experience before proceeding with the Mainroad theme? +### Do I need to have prior experience before proceeding with the Mainroad theme? -**Yes.** We expect that you already have prior experience with Hugo, at least. -[Our docs section]({{< ref "/docs/_index.md" >}} "Mainroad theme documentation") is for intermediate users and -developers, not novice users with zero or minimal experience. Still, all documentation pages would be helpful even if -you don't have such experience. Just don't expect all your typical questions answered here. +**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 +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? @@ -40,39 +40,40 @@ Hugo is not required (but applicable). **Configuration:** -* See [All Configuration Settings](https://gohugo.io/getting-started/configuration/#all-configuration-settings) section -for the full list of Hugo-defined variables with their default value. +* 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. **Front Matter:** -* See [Front Matter Variables](https://gohugo.io/content-management/front-matter#front-matter-variables) section for the +* 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) section for the list of +* See [Mainroad Front Matter example](https://github.com/Vimux/Mainroad#front-matter-example) for the list of Mainroad-specific Front Matter variables. -### What if I have more questions? May I should create an issue? +### What if I have more questions? Should I create an issue? -**We don't provide free personal technical support.** As stated in -[CONTRIBUTING](https://github.com/Vimux/Mainroad/blob/master/CONTRIBUTING.md), please do not use the issue tracker for -personal support. This includes any reports like “how to do this or that”; “everything broken, help me”; “I changed -something, it doesn't work anymore”; “It's not a personal issue, I just want to ask how X or Y works”; “I forked your -theme, then something broken, fix this immediately” and so on. **The issue tracker is the preferred channel for bug -reports, feature requests, and discussions that comply with our contributing rules**, nothing more. All other issues -would be closed and marked as invalid. +**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 +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. + +**The issue tracker should only be used for bug reports, feature requests, and discussions that comply with our +contributing rules**. All other issues will be closed and marked as invalid. ## Technical questions -**I wanted to get the `favicon.ico` and `apple-touch-icon.png` to match my `hightlightColor`, what should I do?** +**I want to get the `favicon.ico` and `apple-touch-icon.png` to match my `hightlightColor`. What should I do?** -There is no way to do this on the fly with Hugo, but you may use two one-liners below with some preparations: +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/favicon.ico` to `./static/favicon.ico` * `./themes/mainroad/apple-touch-icon.png` to `./static/apple-touch-icon.png` -1. Replace the color in variable to your preferred at the beginning of both scripts. Beware, you should use full -six-digit Hex triplet notation (e.g., `#E22D30`) to make it work properly. +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. Go to the root of your project directory in the terminal and execute these two commands accordingly. |