Skip to content

Commit 85a7202

Browse files
authored
Update README.md
1 parent 0ae0310 commit 85a7202

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
## In Example Project
1+
Docsy is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This Docsy example site project uses the Docsy theme, as well as providing a skeleton documentation structure for you to use. You can either copy this project and edit it with your own content (which you can do from the example or theme project), or use the theme in your projects like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/).
22

3-
The below will give you project that is set up and ready to use.
3+
You can find detailed theme instructions in the example project under **Documentation - Getting Started**.
4+
5+
6+
## Cloning the Example Project
7+
8+
The following will give you a project that is set up and ready to use.
49

510
```bash
611
git clone --recurse-submodules --depth 1 https://github.com/bep/tech-doc-hugo-example.git
@@ -21,7 +26,7 @@ If you want to do SCSS edits and want to publish these, you need to install `Pos
2126
npm install
2227
```
2328

24-
## In Theme Project
29+
### Cloning the Example from the Theme Project
2530

2631

2732
```bash
@@ -37,4 +42,14 @@ Note that the Hugo Theme Site requires the `exampleSite` to live in a subfolder
3742
git subtree add --prefix exampleSite https://github.com/bep/tech-doc-hugo-example.git master --squash
3843
```
3944

40-
To pull in changes, see `pull-deps.sh` script in the theme.
45+
To pull in changes, see `pull-deps.sh` script in the theme.
46+
47+
## Running the website locally
48+
49+
Once you've cloned the site repo, from the repo root folder, run:
50+
51+
```
52+
hugo server
53+
```
54+
55+
Navigate to http://localhost:1313/td/docs/getting-started/ to read the theme documentaton.

0 commit comments

Comments
 (0)