Skip to content

Commit

Permalink
Merge pull request #1 from google/Update-repo-names
Browse files Browse the repository at this point in the history
Update repo names
  • Loading branch information
LisaFC authored Oct 15, 2018
2 parents bb26b7b + ac2169a commit 2d803c7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 14 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ This is not an officially supported Google product.

## Cloning the Example Project

The following will give you a project that is set up and ready to use.
The following will give you a project that is set up and ready to use (don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site). The `hugo server` command builds and serves the site. If you just want to build the site, run `hugo` instead.

```bash
git clone --recurse-submodules --depth 1 https://github.com/bep/tech-doc-hugo-example.git
cd tech-doc-hugo-example
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
cd docsy-example
hugo server
```

Note that the theme is included as a Git submodule:
The theme is included as a Git submodule:

```bash
▶ git submodule
a053131a4ebf6a59e4e8834a42368e248d98c01d themes/tech-doc-hugo-theme (heads/master)
a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master)
```

If you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`):
Expand All @@ -31,7 +31,7 @@ npm install


```bash
git clone --recurse-submodules --depth 1 https://github.com/bep/tech-doc-hugo-theme.git
git clone --recurse-submodules --depth 1 https://github.com/docsy.git
cd tech-doc-hugo-theme/exampleSite
HUGO_THEMESDIR="../.." hugo server
```
Expand All @@ -40,7 +40,7 @@ HUGO_THEMESDIR="../.." hugo server
Note that the Hugo Theme Site requires the `exampleSite` to live in a subfolder of the theme itself. To avoid recursive duplication, the example site is added as a Git subtree:

```bash
git subtree add --prefix exampleSite https://github.com/bep/tech-doc-hugo-example.git master --squash
git subtree add --prefix exampleSite https://github.com/google/docsy.git master --squash
```

To pull in changes, see `pull-deps.sh` script in the theme.
Expand Down
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title = "Docsy Example"
enableRobotsTXT = true

# Hugo allows theme composition (and inheritance). The precedence is from left to right.
theme = ["tech-doc-hugo-theme"]
theme = ["docsy"]

# Will give values to .Lastmod etc.
enableGitInfo = true
Expand Down
6 changes: 0 additions & 6 deletions content/en/docs/Getting started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@ Welcome to the Docsy theme user guide! This guide shows you how to get started c

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.

```bash
cd <your-hugo-project>/themes
git submodule add TODO(bep)
git submodule update --init --recursive
```

If you want to do stylesheet changes, you will also need `PostCSS` to create the final assets:

```
Expand Down

0 comments on commit 2d803c7

Please sign in to comment.