Changed the Gitea integration example.
All checks were successful
the build was successful

Made it so that link tags only appear in repo pages.
This commit is contained in:
tastytea 2019-04-18 07:28:04 +02:00
parent 6d07f08607
commit f155d2bf1b
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07

View File

@ -2,7 +2,7 @@
:doctype: manpage :doctype: manpage
:Author: tastytea :Author: tastytea
:Email: tastytea@tastytea.de :Email: tastytea@tastytea.de
:Date: 2019-04-17 :Date: 2019-04-18
:Revision: 0.0.0 :Revision: 0.0.0
:man source: gitea2rss :man source: gitea2rss
:man version: {revision} :man version: {revision}
@ -28,21 +28,23 @@ slash. For example: _https://git.example.com_. The *QUERY_STRING* must contain
_repo=user/project_. The feed-URL for alice's project, cooltool, would be: _repo=user/project_. The feed-URL for alice's project, cooltool, would be:
`https://rss.example.com/?repo=alice/cooltool`. `https://rss.example.com/?repo=alice/cooltool`.
The generated RSS feed contains the *channel* elements _title_, _link_,
_description_, _generator_ and _lastBuildDate_ and the *item* elements _title_,
_link_, _guid_, _pubDate_ and _description_. Since Gitea has no individual pages
for each release, _link_ elements in *item* are set to the overview page for
releases.
== GITEA INTEGRATION
You can let Gitea automatically insert links to your RSS feeds by editing You can let Gitea automatically insert links to your RSS feeds by editing
`${GITEA_CUSTOM}/templates/custom/header.tmpl` and putting something like `${GITEA_CUSTOM}/templates/custom/header.tmpl` and putting something like
this in it: this in it:
[source,html] [source,html]
---- ----
<link rel="alternate" type="application/rss+xml" title="Releases of {{.Repository.Name}}" href="https://rss.example.com/?repo={{.Repository.Owner.Name}}/{{.Repository.Name}}" /> {{if .Repository.Name}}<link rel="alternate" type="application/rss+xml" title="Releases of {{.Repository.Name}}" href="https://rss.example.com/?repo={{.Repository.Owner.Name}}/{{.Repository.Name}}" />{{end}}
---- ----
The generated RSS feed contains the *channel* elements _title_, _link_,
_description_, _generator_ and _lastBuildDate_ and the *item* elements _title_,
_link_, _guid_, _pubDate_ and _description_. Since Gitea has no individual pages
for each release, _link_ elements in *item* are set to the overview page for
releases.
== PROXY SERVERS == PROXY SERVERS
Since gitea2rss is built on libcurl, it respects the same proxy environment Since gitea2rss is built on libcurl, it respects the same proxy environment