diff options
author | LisaFC <lcarey@google.com> | 2021-02-02 16:45:50 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-02 16:45:50 +0300 |
commit | 15e69c4dd31b5d05ac295721a273ca607e405af6 (patch) | |
tree | c37165def4234ddf257ec0c4f53490e471f5793d | |
parent | 5dec904fb4e0d2fb76fa2d66cce62ca491ba7579 (diff) |
Update as example is now a template repo
-rwxr-xr-x | userguide/content/en/docs/Getting started/_index.md | 22 |
1 files changed, 3 insertions, 19 deletions
diff --git a/userguide/content/en/docs/Getting started/_index.md b/userguide/content/en/docs/Getting started/_index.md index e4ea7f2..2b6867e 100755 --- a/userguide/content/en/docs/Getting started/_index.md +++ b/userguide/content/en/docs/Getting started/_index.md @@ -84,17 +84,17 @@ To use the Docsy Hugo theme, you have a couple of options: * **Copy and edit the source for the [Docsy example site](https://github.com/google/docsy-example).** This approach gives you a skeleton structure for your site, with top-level and documentation sections and templates that you can modify as necessary. The example site uses Docsy as a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so it's easy to [keep up to date](/docs/updating/). * **Build your own site using the Docsy theme.** Specify the [Docsy theme](https://github.com/google/docsy) like any other [Hugo theme](https://gohugo.io/themes/) when creating or updating your site. With this option, you'll get Docsy look and feel, navigation, and other features, but you'll need to specify your own site structure. -### Option 1: Clone the Docsy example site +### Option 1: Copy the Docsy example site The [Example Site](https://example.docsy.dev) gives you a good starting point for building your docs site and is -pre-configured to use the Docsy theme as a Git submodule. You can clone the Example Site either by: +pre-configured to use the Docsy theme as a Git submodule. You can copy the Example Site either by: * [Using the GitHub UI](#using-the-github-ui) * [Using the command line](#using-the-command-line) #### Using the GitHub UI -<!--This is the simplest approach, as the Docsy example site repo is a [template repository](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/). To create your own copy of the Docsy example site repo: +This is the simplest approach, as the Docsy example site repo is a [template repository](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/). To create your own copy of the Docsy example site repo: 1. Go to the [repo page](https://github.com/google/docsy-example) and click **Use this template**. @@ -108,24 +108,8 @@ pre-configured to use the Docsy theme as a Git submodule. You can clone the Exam git clone --recurse-submodules --depth 1 <em>https://github.com/my/example.git</em> </pre> -You can now edit your local versions of the site's source files. To preview your site, go to your site root directory and run `hugo server` ([see the known issues on MacOS](#known-issues)). By default, your site will be available at http://localhost:1313/. To push changes to your new repo, go to your site root directory and use `git push`.--> - -Note that the following approach [forks](https://help.github.com/en/articles/fork-a-repo) our repo and so creates a connection in GitHub between your project repo and the Docsy example site project repo - our project will be the "upstream" version of your site project: - -1. In the [Docsy example site's GitHub repo](https://github.com/google/docsy-example), click **Fork** and follow the prompts. -1. Rename your new fork: - 1. Click **Settings**, and type a new name in the **Repository name** field. - 1. Click **Rename** to save your changes. -1. Get the web URL for cloning your site repo by clicking **Clone or download** on its main repo page. -1. Make your own local working copy of your repo using `git clone`, replacing `https://github.com/my/example.git` with your repo's web URL: - - <pre> - git clone --recurse-submodules --depth 1 <em>https://github.com/my/example.git</em> - </pre> - You can now edit your local versions of the site's source files. To preview your site, go to your site root directory and run `hugo server` ([see the known issues on MacOS](#known-issues)). By default, your site will be available at http://localhost:1313/. To push changes to your new repo, go to your site root directory and use `git push`. - #### Using the command line To copy the example site: |