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.

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

[feat] Support contributingUrl param #2067

Merged
merged 2 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,15 @@ For the full list of changes, see the [0.x.y] release notes.

- Support for Right-To-Left (RLT) languages is reintroduced via [Bootstrap's
base support for RTL][bs-rtl].
- The URL to your project's contribution guidelines is configurable. For
details, see [Adding a community page].

**Other changes**:
**Other changes**: TBC

[0.x.y]: https://github.com/google/docsy/releases/latest?FIXME=v0.X.Y
[bs-rtl]: https://getbootstrap.com/docs/5.3/getting-started/rtl/
[Adding a community page]:
https://www.docsy.dev/docs/adding-content/content/#adding-a-community-page

## 0.10.0

Expand Down
3 changes: 2 additions & 1 deletion layouts/partials/community_links.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{{ $links := .Site.Params.links -}}
{{ $contribUrl := .Params.contributingUrl | default "docs/contribution-guidelines" -}}

<section class="row td-box td-box--white td-box--height-auto linkbox">
<div class="col-xs-12 col-sm-6 col-md-6 col-lg-6">
Expand All @@ -16,7 +17,7 @@ <h2>{{ T "community_develop" }}</h2>
{{ end }}
<p>
{{ T "community_how_to" . }}
<a href="{{ "docs/contribution-guidelines" | relURL }}">{{ T "community_guideline" }}</a>.
<a href="{{ $contribUrl | relURL }}">{{ T "community_guideline" }}</a>.
</p>
</div>
</section>
Expand Down
10 changes: 10 additions & 0 deletions userguide/content/en/docs/adding-content/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,16 @@ params:

If you're creating your own site and want to add a page using this template, add a `/community/_index.md` file in your content root directory. If you've copied the example site and *don't* want a community page, just delete the `/content/en/community/` directory in your project repo.

By default, Docsy layouts assume that your project's contributing page is found
at `<baseURL>/docs/contribution-guidelines`. To specify another URL, add it to
the front matter of `/community/_index.md` as illustrated next. The URL can be
an external URL or a local path:

```yaml
params:
contributingUrl: docs/contributing/
```

## Adding static content

You may want to serve some non-Hugo-built content along with your site: for example, if you have generated reference docs using Doxygen, Javadoc, or other doc generation tools.
Expand Down
Loading