Skip to content

Commit d776e07

Browse files
committed
WIP: Update user guide
1 parent 04f235d commit d776e07

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

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

+56-2
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,65 @@ 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 only GitHub repository links "out of the box". Since GitLab can handle the same link scheme, it should work as well. If you are using another repository such as Bitbucket and would like generated repository links, feel free to [add a feature request or update our theme](/docs/contribution-guidelines/).
18+
Currently, Docsy supports GitHub, Azure de and Gitea repository links "out of the box". Since GitLab can handle the same link scheme as GitHub, it should work as well. If you are using another repository such as Bitbucket and would like generated repository links, feel free to [add a feature request or update our theme](/docs/contribution-guidelines/).
1919

2020
## Link configuration
2121

22-
There are four 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 one in your page metadata.
23+
24+
{{< tabpane >}}
25+
{{< tab header="Configuration file:" disabled=true />}}
26+
{{< tab header="hugo.toml" lang="toml" >}}
27+
[params.repo]
28+
type = "github"
29+
url = "https://github.com/google/docsy"
30+
subdir = "userguide"
31+
branch = "release"
32+
project_url = "https://github.com/google/docsy
33+
{{< /tab >}}
34+
{{< tab header="hugo.yaml" lang="yaml" >}}
35+
params:
36+
repo:
37+
type: github
38+
url: https://github.com/google/docsy
39+
subdir: "userguide"
40+
branch: "release"
41+
project_url: "https://github.com/google/docsy
42+
{{< /tab >}}
43+
{{< tab header="hugo.json" lang="json" >}}
44+
{
45+
"params": {
46+
"repo": {
47+
"type": "github",
48+
"url": "https://github.com/google/docsy",
49+
"subdir": "userguide",
50+
"branch"= "release",
51+
"project_url" = "https://github.com/google/docsy
52+
}
53+
}
54+
}
55+
{{< /tab >}}
56+
{{< /tabpane >}}
57+
58+
### `repo.type`
59+
60+
### `repo.url`
61+
62+
### `repo.subdir` (optional)
63+
64+
### `repo.branch` (optional)
65+
66+
### `repo.project_url` (optional)
67+
68+
### Working with git submodules (`path_base_for_subdir`)
69+
70+
## GitHub configuration (deprecated)
71+
72+
{{% alert title="Deprecation note" color="warning" %}}
73+
These setting are deprecated. Use the params described in [Link Configuration][] instead.
74+
75+
[Link Configuration]: #link-configuration
76+
{{% /alert %}}
2377

2478
### `github_repo`
2579

0 commit comments

Comments
 (0)