luzifer/go-latestver
1
0
Fork 0
mirror of https://github.com/Luzifer/go-latestver.git synced 2024-11-14 01:42:41 +00:00
Code Issues Projects Releases Wiki Activity

Add docs for links

Browse source 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2021-12-01 18:07:48 +01:00
parent 3a3aedf998
commit b8a6573106
Signed by: luzifer
GPG key ID: 0066F03ED215AD7D
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/config.md
View file

@ -13,6 +13,11 @@ catalog:
url: https://alpinelinux.org/downloads/ url: https://alpinelinux.org/downloads/
xpath: '//div[@class="l-box"]/p/strong' xpath: '//div[@class="l-box"]/p/strong'
links:
- icon_class: 'fas fa-globe'
name: 'Website'
url: 'https://alpinelinux.org'
check_interval: 1h check_interval: 1h
... ...
@ -22,6 +27,8 @@ Each catalog entry contains a `name` and a `tag` representing the entry. You can
Additionally you will configure a `fetcher` with its corresponding `fetcher_config` for the catalog entry. In the example above the `html` fetcher is used with two attributes configured. The attributes for each fetcher can be found below. Additionally you will configure a `fetcher` with its corresponding `fetcher_config` for the catalog entry. In the example above the `html` fetcher is used with two attributes configured. The attributes for each fetcher can be found below.
You can provide your own `links` for each catalog entry which will be added to or override the links returned from the fetcher. If you provide the same `name` as the fetcher uses the link of the fetcher will be overridden. The `icon_class` should consist of `fas` or `fab` and an icon (for example `fa-global`). You can use all **solid** (`fas`) or **breand** (`fab`) icons within [Font Awesome v5 Free](https://fontawesome.com/v5.15/icons?d=gallery&s=brands,solid&m=free).
## Available Fetchers ## Available Fetchers
## Fetcher: `atlassian` ## Fetcher: `atlassian`

7
docs/config.md.tpl
View file

@ -13,6 +13,11 @@ catalog:
url: https://alpinelinux.org/downloads/ url: https://alpinelinux.org/downloads/
xpath: '//div[@class="l-box"]/p/strong' xpath: '//div[@class="l-box"]/p/strong'
links:
- icon_class: 'fas fa-globe'
name: 'Website'
url: 'https://alpinelinux.org'
check_interval: 1h check_interval: 1h
... ...
@ -22,6 +27,8 @@ Each catalog entry contains a `name` and a `tag` representing the entry. You can
Additionally you will configure a `fetcher` with its corresponding `fetcher_config` for the catalog entry. In the example above the `html` fetcher is used with two attributes configured. The attributes for each fetcher can be found below. Additionally you will configure a `fetcher` with its corresponding `fetcher_config` for the catalog entry. In the example above the `html` fetcher is used with two attributes configured. The attributes for each fetcher can be found below.
You can provide your own `links` for each catalog entry which will be added to or override the links returned from the fetcher. If you provide the same `name` as the fetcher uses the link of the fetcher will be overridden. The `icon_class` should consist of `fas` or `fab` and an icon (for example `fa-global`). You can use all **solid** (`fas`) or **breand** (`fab`) icons within [Font Awesome v5 Free](https://fontawesome.com/v5.15/icons?d=gallery&s=brands,solid&m=free).
## Available Fetchers ## Available Fetchers
{% for module in modules -%} {% for module in modules -%}