diff --git a/README.md b/README.md index 8df4026..dc64d98 100644 --- a/README.md +++ b/README.md @@ -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`): @@ -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 ``` @@ -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. diff --git a/config.toml b/config.toml index 08bed25..e159fbc 100644 --- a/config.toml +++ b/config.toml @@ -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 diff --git a/content/en/docs/Getting started/_index.md b/content/en/docs/Getting started/_index.md index adc936a..1722265 100755 --- a/content/en/docs/Getting started/_index.md +++ b/content/en/docs/Getting started/_index.md @@ -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 /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: ```