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: fixing typos #1087

Merged
merged 1 commit into from
Jul 1, 2022
+4 −4
Merged

User guide: fixing typos #1087

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion userguide/content/en/docs/Best practices/organizing-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You may also want to create some tasks/how-tos for your project's features. Feel
site or even just the docs section instead if you like this simpler structure better.

{{% alert title="Tip" %}}
If you want to copy this guide, be aware that its [source files](https://github.com/google/docsy/tree/main/userguide) are *inside* the Docsy theme repo, and so it doesn't have its own `themes/` directory: instead, we run `hugo server --themesDir ../..` to use Docsy from its parent directory. You may want to either copy the site and [add a `themes/` directory with Docsy](/docs/get-started/other-options/#other-option-2-clone-the-docsy-theme), or just copy the `docs/` folder into your existing site's content root.
If you want to copy this guide, be aware that its [source files](https://github.com/google/docsy/tree/main/userguide) are *inside* the Docsy theme repo, and so it doesn't have its own `themes/` directory: instead, we run `hugo server --themesDir ../..` to use Docsy from its parent directory. You may want to either copy the site and [add a `themes/` directory with Docsy](/docs/get-started/other-options/#option-2-clone-the-docsy-theme), or just copy the `docs/` folder into your existing site's content root.
{{% /alert %}}

[Learn more about how Hugo and Docsy use folders and other files to organize your site](/docs/adding-content/content/#organizing-your-documentation).
Expand Down
2 changes: 1 addition & 1 deletion userguide/content/en/docs/Get started/other-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ following commands:
echo 'theme = "docsy"' >> config.toml
```

3. Install postCSS as [instructed earlier](install-postcss).
3. Install postCSS as [instructed earlier](#install-postcss).

4. Get Docsy dependencies:

Expand Down
4 changes: 2 additions & 2 deletions userguide/content/en/docs/Updating/Updating-submodules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you intend to update your site, consider [converting your site to Hugo Module

## Update your Docsy submodule

If you are using the [Docsy theme as a submodule](/docs/get-started/other-options/#other-option-1-use-the-theme-as-a-submodule) in your project, here's how you update the submodule:
If you are using the [Docsy theme as a submodule](/docs/get-started/other-options/#option-1-docsy-as-a-git-submodule) in your project, here's how you update the submodule:

1. Navigate to the root of your local project, then run:

Expand All @@ -37,7 +37,7 @@ If you are using the [Docsy theme as a submodule](/docs/get-started/other-option

## Route 2: Update your Docsy clone

If you [cloned the Docsy theme](/docs/get-started/other-options/#other-option-2-clone-the-docsy-theme) into
If you [cloned the Docsy theme](/docs/get-started/other-options/#option-2-clone-the-docsy-theme) into
the `themes` folder in your project, then you use the `git pull` command:

1. Navigate to the `themes` directory in your local project:
Expand Down