Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User guide, installation from example site: clone latest tagged version #1577

Merged
merged 1 commit into from
Jun 16, 2023
Merged

User guide, installation from example site: clone latest tagged version #1577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions userguide/content/en/docs/get-started/docsy-as-module/example-site-as-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you prefer to create a site from scratch, follow the instructions in Start a
At your Unix shell or Windows command line, run the following command:

```bash
git clone https://github.com/google/docsy-example.git my-new-site
git clone --depth 1 --branch v{{% param "version" %}} https://github.com/google/docsy-example.git my-new-site
cd my-new-site
hugo server
```
Expand All @@ -39,14 +39,18 @@ There are two different routes to get a local clone of the example site:
If you want to use a remote repository other than GitHub (such as [GitLab](https://gitlab.com), [BitBucket](https://bitbucket.org/), [AWS CodeCommit](https://aws.amazon.com/codecommit/), [Gitea](https://gitea.io/)) or if you don't want a remote repo at all, simply make a local working copy of the example site directly using `git clone`. As last parameter, give your chosen local repo name (here: `my-new-site`):

```bash
git clone https://github.com/google/docsy-example.git my-new-site
git clone --depth 1 --branch v{{% param "version" %}} https://github.com/google/docsy-example.git my-new-site
```

#### Option 2: Using the GitHub UI (local copy + associated GitHub repo)

As the Docsy example site repo is a [template repository](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/), creating your own remote GitHub clone of this Docsy example site repo is quite easy:

1. Go to the [Docsy example site repo](https://github.com/google/docsy-example) and click **Use this template**.
1. Go to the repo of the [Docsy example site](https://github.com/google/docsy-example).

1. Use the dropdown for switching branches/tags to change to the latest released tag `v{{% param "version" %}}`.

1. Click the button **Use this template** and select the option `Create a new repository` from the dropdown.

1. Chose a name for your new repository (e.g. `my-new-site`) and type it in the **Repository name** field. You can also add an optional **Description**.

Expand Down