mirror/Jackett
1
0
Fork 0
mirror of https://github.com/Jackett/Jackett synced 2025-01-03 05:36:44 +00:00
Code Issues Releases Wiki Activity

Updated Definition format (markdown)

garfield69 2024-06-17 16:44:12 +12:00
parent 0578ba8ef4
commit 01e26dc4ad
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Definition-format.md

@ -13,7 +13,7 @@ In general, using cardigann definitions is the preferred way of adding new index
# Schema # Schema
To help you conform to YML coding standards, (and maintain compatibility parity with the v9 Prowlarr yaml indexers), you can validate your Jackett yaml Indexer by using the npm ajv tool. To help you conform to YML coding standards, (and maintain compatibility parity with the v10 Prowlarr yaml indexers), you can validate your Jackett yaml Indexer by using the npm ajv tool.
## Installation ## Installation
The following npm packages are required `ajv-cli-servarr ajv-formats`. The following npm packages are required `ajv-cli-servarr ajv-formats`.
@ -40,9 +40,15 @@ Each definition must start with a header like this:
# web site, in lower case, stripped of any special characters and space # web site, in lower case, stripped of any special characters and space
id: thepiratebay id: thepiratebay
# [REQUIRED] Display name (The full name of the tracker) # [REQUIRED] Display name (The full name of the tracker)
name: The Pirate Bay name: The Pirate Bay
# [OPTIONAL] This is an administrative function which should not be used by the end user.
# It is used to maintain backward compatibility when renaming the id of an indexer
# (the id is used in the torznab/download/search urls and in the indexer configuration file)
replaces:
- tpb-original
# [REQUIRED] displayed in the tooltip on the add-indexer page and in the config panel # [REQUIRED] displayed in the tooltip on the add-indexer page and in the config panel
description: "Pirate Bay (TPB) is the galaxy’s most resilient Public BitTorrent site" description: "Pirate Bay (TPB) is the galaxy’s most resilient Public BitTorrent site"