Skip to content

Commit 0c11ae5

Browse files
committed
Update documentation
1 parent f09698a commit 0c11ae5

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

userguide/content/en/docs/adding-content/repository-links.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ The Docsy [docs and blog layouts](/docs/adding-content/content/#adding-docs-and-
1515

1616
This page shows you how to configure these links.
1717

18-
Currently, Docsy supports GitHub, Azure DevOps and Gitea repository links "out of the box". If you are using another repository such as Bitbucket and would like generated repository links, you can add a custom template to render the links. Feel free to [add a feature request or update our theme](/docs/contribution-guidelines/).
18+
Currently, Docsy supports GitHub, Azure DevOps, GitLab and Gitea repository links "out of the box". If you are using another repository such as Bitbucket and would like generated repository links, you can add a custom template to render the links. Feel free to [add a feature request or update our theme](/docs/contribution-guidelines/).
1919

2020
## Link configuration
2121

22-
There are a few site variables you can configure in `hugo.toml`/`hugo.yaml`/`hugo.json` to set up links, as well as one in your page metadata.
22+
There are a few site variables you can configure in `hugo.toml`/`hugo.yaml`/`hugo.json` to set up links, as well as in your page metadata.
2323

2424
{{< tabpane >}}
2525
{{< tab header="Configuration file:" disabled=true />}}
@@ -29,7 +29,7 @@ There are a few site variables you can configure in `hugo.toml`/`hugo.yaml`/`hug
2929
url = "https://github.com/google/docsy"
3030
subdir = "userguide"
3131
branch = "release"
32-
project_url = "https://github.com/google/docsy
32+
project_url = "https://github.com/google/docsy"
3333
{{< /tab >}}
3434
{{< tab header="hugo.yaml" lang="yaml" >}}
3535
params:
@@ -38,7 +38,7 @@ params:
3838
url: https://github.com/google/docsy
3939
subdir: "userguide"
4040
branch: "release"
41-
project_url: "https://github.com/google/docsy
41+
project_url: "https://github.com/google/docsy"
4242
{{< /tab >}}
4343
{{< tab header="hugo.json" lang="json" >}}
4444
{
@@ -48,7 +48,7 @@ params:
4848
"url": "https://github.com/google/docsy",
4949
"subdir": "userguide",
5050
"branch"= "release",
51-
"project_url" = "https://github.com/google/docsy
51+
"project_url" = "https://github.com/google/docsy"
5252
}
5353
}
5454
}
@@ -57,36 +57,35 @@ params:
5757

5858
### `repo.type`
5959

60-
Repo Links are created differently for different git repositories. Currently Docsy supports [GitHub](https://www.github.com), [Azure DevOps](https://azure.microsoft.com/products/devops) and [Gitea](https://about.gitea.com). Specify the type of repository you are using. Supported values are `github`, `azure`, `gitea`.
60+
Repo Links are created differently for different types of git repositories. Currently Docsy supports [GitHub](https://www.github.com), [Azure DevOps](https://azure.microsoft.com/products/devops), [GitLab](https://about.gitlab.com) and [Gitea](https://about.gitea.com). Specify the type of repository you are using, supported values are `github`, `azure`, `gitlab`, `gitea`.
6161

6262
Other repo types:
6363

64-
* [GitLab](https://about.gitlab.com) can handle the same link scheme as GitHub, so you can use `type: gitlab`.
65-
* [Forgejo](https://forgejo.org) is a fork of gitea and uses the same link schem as gitea, so you can use `type: gitea`.
64+
* [Forgejo](https://forgejo.org) is a fork of gitea and uses the same link schema as gitea, so you can use `type: gitea`.
6665
* To use a **custom repository type**
6766
* define `type: custom` in your configuration and
6867
* place a custom template in your project at `layouts/partials/repo-links-custom.html` which will be used to render the links.
6968
Instead of `custom` you can use any type, you like.
7069

7170
### `repo.url`
7271

73-
The URL for your site's source repository. This is used to generate the Edit this page, Create child page, and Create documentation issue links.
72+
The URL for your site's source repository. This is used to generate the *Edit this page*, *Create child page*, and *Create documentation issue* links.
7473

7574
### `repo.subdir` (optional)
7675

7776
Specify a value here if your content directory is not in your repo's root directory. For example, this site is in the userguide subdirectory of its repo. Setting this value means that your edit links will go to the right page.
7877

7978
### `repo.branch` (optional)
8079

81-
Specify a value here if you have would like to reference a different branch in the links to your repository like Edit this page or Create project issue.
80+
Specify a value here if you have would like to reference a different branch than `main` in the links to your repository like *Edit this page*.
8281

8382
### `repo.project_url` (optional)
8483

85-
Specify a value here if you have a separate project repo and you'd like your users to be able to create issues against your project from the relevant docs. The Create project issue link appears only if this is set.
84+
Specify a value here if you have a separate project repo and you'd like your users to be able to create issues against your project from the relevant docs. The *Create project issue* link appears only if this is set.
8685

8786
It is assumed that the `project_url` points to the same type of git repository as your documentation site.
8887

89-
### Working with git submodules: `path_base_for_subdir` (optional)
88+
### `path_base_for_subdir` (optional)
9089

9190
Suppose that the source files for all of the pages under `content/some-section`
9291
come from another repo, such as a [git submodule][]. Add settings like these to
@@ -99,6 +98,7 @@ section refer to the originating repo:
9998
+++
10099
title = "Some super section"
101100
[cascade.repo]
101+
type = "github"
102102
url = "https://github.com/some-username/another-repo/"
103103
subdir = "docs"
104104
path_base_for_subdir = "content/some-section"
@@ -110,6 +110,7 @@ path_base_for_subdir = "content/some-section"
110110
title: Some super section
111111
cascade:
112112
repo:
113+
type: github
113114
url: https://github.com/some-username/another-repo/
114115
subdir: docs
115116
path_base_for_subdir: content/some-section
@@ -121,6 +122,7 @@ cascade:
121122
"title": "Some super section",
122123
"cascade": {
123124
repo: {
125+
"type": "github",
124126
"url": "https://github.com/some-username/another-repo/",
125127
"subdir": "docs",
126128
"path_base_for_subdir": "content/some-section"
@@ -139,7 +141,7 @@ As an example, consider a page at the path
139141
https://github.com/some-username/another-repo/edit/main/docs/subpath/some-page.md
140142
```
141143

142-
To make it clear, without the settings in the sections index page, the Edit link would be:
144+
To make it clear, without the settings in the sections index page, the edit link would be:
143145

144146
```nocode
145147
https://github.com/google/docsy/edit/main/userguide/content/some-section/subpath/some-page.md

0 commit comments

Comments
 (0)