You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/Getting started/_index.md
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,11 @@ resources:
12
12
byline: "Photo: Bjørn Erik Pedersen / CC-BY-SA"
13
13
---
14
14
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.
16
16
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.
18
20
19
21
```bash
20
22
cd<your-hugo-project>/themes
@@ -36,6 +38,12 @@ npm install -g postcss-cli
36
38
npm install -g autoprefixer
37
39
```
38
40
41
+
To use a local version of the theme files during site development, clone the repo using:
For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/)
40
48
41
49
## Using the theme
@@ -51,7 +59,7 @@ See the examples with comments in `config.toml` in this project for how to add y
51
59
52
60
## Content sections
53
61
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`.
55
63
56
64
### RSS feeds
57
65
@@ -417,7 +425,7 @@ Follow the instructions in [Host on Netlify](https://gohugo.io/hosting-and-deplo
417
425
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:
418
426
419
427
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).
421
429
1. Run the `hugo` command in your site root.
422
430
1. Add the generated `resources/` directory and commit back to the repo.
0 commit comments