Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LisaFC authored Oct 9, 2018
1 parent 0ae0310 commit 85a7202
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
## In Example Project
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/).

The below will give you project that is set up and ready to use.
You can find detailed theme instructions in the example project under **Documentation - Getting Started**.


## Cloning the Example Project

The following will give you a project that is set up and ready to use.

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

## In Theme Project
### Cloning the Example from the Theme Project


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

To pull in changes, see `pull-deps.sh` script in the theme.
To pull in changes, see `pull-deps.sh` script in the theme.

## Running the website locally

Once you've cloned the site repo, from the repo root folder, run:

```
hugo server
```

Navigate to http://localhost:1313/td/docs/getting-started/ to read the theme documentaton.

0 comments on commit 85a7202

Please sign in to comment.