Skip to content

Commit 0ae0310

Browse files
authored
Minor tweaks to instructions
1 parent 2c162c3 commit 0ae0310

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

content/en/docs/Getting started/_index.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ resources:
1212
byline: "Photo: Bjørn Erik Pedersen / CC-BY-SA"
1313
---
1414

15-
## Installing theme tools
15+
Welcome to the Docsy theme user guide! This guide shows you how to get started creating technical documentation sites using Docsy, including site customization and how to use Docsy's blocks and templates.
1616

17-
You need a [recent version](https://github.com/gohugoio/hugo/releases) of Hugo to run this project locally (if you install from the release page, make sure to get the `extended` Hugo version). Hugo can be installed via Brew if you're running MacOs.
17+
## Installation and prerequisites
18+
19+
You need a [recent version](https://github.com/gohugoio/hugo/releases) of Hugo to build and run sites (like this one) that use Docsy locally. If you install from the release page, make sure to get the `extended` Hugo version, which supports SCSS. Hugo can be installed via Brew if you're running MacOs.
1820

1921
```bash
2022
cd <your-hugo-project>/themes
@@ -36,6 +38,12 @@ npm install -g postcss-cli
3638
npm install -g autoprefixer
3739
```
3840

41+
To use a local version of the theme files during site development, clone the repo using:
42+
43+
```
44+
git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
45+
```
46+
3947
For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/)
4048

4149
## Using the theme
@@ -51,7 +59,7 @@ See the examples with comments in `config.toml` in this project for how to add y
5159

5260
## Content sections
5361

54-
The theme comes with templates for the top level sections `docs`, `blog`, and `community`, and a default landing page type of template used for any other section. The `community` landing page template has boilerplate content that's automatically filled in with your community links.
62+
The theme comes with templates for the top level sections `docs`, `blog`, and `community`, and a default landing page type of template used for any other section. The `community` landing page template has boilerplate content that's automatically filled in with the project name and community links specified in `config.toml`.
5563

5664
### RSS feeds
5765

@@ -417,7 +425,7 @@ Follow the instructions in [Host on Netlify](https://gohugo.io/hosting-and-deplo
417425
At the moment due to Netlify system limitations, Netlify does not support the "extended" version of Hugo needed to use SCSS, which is used by our theme. This is a known issue and the fix will be rolled out in future versions of Netlify. A workaround until then is to build the site on your local machine with "extended" Hugo, and then commit the generated `resources/` folder to your site repo on GitHub. To do this:
418426

419427
1. Ensure you have an up to date local copy of your site files cloned from your repo.
420-
1. Ensure you have the tools described in Installing Theme Tools installed on your local machine, including `postcss-cli` (you'll need it to generate the site resources).
428+
1. Ensure you have the tools described in [Installation and Prerequisites](#installation-and-prerequisites) installed on your local machine, including `postcss-cli` (you'll need it to generate the site resources).
421429
1. Run the `hugo` command in your site root.
422430
1. Add the generated `resources/` directory and commit back to the repo.
423431

0 commit comments

Comments
 (0)