-
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
107 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
{ | ||
"$schema": "https://json-schema.org/draft-07/schema", | ||
"title": "RSS feeds (i.e. a channel of items) using git log and page metadata.", | ||
"oneOf": [ | ||
{ | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/", | ||
"enum": ["rss"] | ||
}, | ||
{ | ||
"type": "object", | ||
"properties": { | ||
"rss": { | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/", | ||
"type": "object", | ||
"properties": { | ||
"abstract_chars_count": { | ||
"title": "Number of characters to use as item description if it's not present within the page metadata. If this value is set to -1, then the articles' full HTML content will be filled into the description element.", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#feed-length", | ||
"type": "integer", | ||
"default": 160, | ||
"minimum": -1 | ||
}, | ||
"categories": { | ||
"title": "List of page metadata keys to use as item categories.", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/##item-categories", | ||
"type": "array", | ||
"default": null, | ||
"items": { | ||
"type": "string" | ||
}, | ||
"minItems": 1, | ||
"uniqueItems": true | ||
}, | ||
"comments_path": { | ||
"title": "Part of URL to the items' comment div.", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#item-comments-path", | ||
"type": "string", | ||
"default": null, | ||
"format": "uri-reference" | ||
}, | ||
"date_from_meta": { | ||
"title": "Use date from page metadata instead of git log.", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#dates-overriding", | ||
"type": "object", | ||
"default": null, | ||
"properties": { | ||
"as_creation": { | ||
"type": ["boolean", "string"] | ||
}, | ||
"as_update": { | ||
"type": ["boolean", "string"] | ||
}, | ||
"datetime_format": { | ||
"type": ["null", "string"] | ||
} | ||
} | ||
}, | ||
"enabled": { | ||
"title": "Enable/Disable plugin", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin", | ||
"type": "boolean", | ||
"default": true | ||
}, | ||
"feed_ttl": { | ||
"title": "Number of pages to include as feed items (entries).", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#feed-length", | ||
"type": "integer", | ||
"default": 1440 | ||
}, | ||
"image": { | ||
"title": "Feed channel illustration", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#channel-image", | ||
"type": "string", | ||
"default": null | ||
}, | ||
"length": { | ||
"title": "Number of pages to include as feed items (entries).", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#feed-length", | ||
"type": "integer", | ||
"default": 20 | ||
}, | ||
"match_path": { | ||
"title": "Regex match pattern to filter pages.", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#filter-pages", | ||
"type": "string", | ||
"default": ".*" | ||
}, | ||
"pretty_print": { | ||
"title": "Minify/Prettify output", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#prettified-output", | ||
"type": "boolean", | ||
"default": false | ||
}, | ||
"url_parameters": { | ||
"title": "URL parameters to include in the item URL.", | ||
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#url-parameters", | ||
"type": "object", | ||
"default": null | ||
} | ||
}, | ||
"additionalProperties": false | ||
} | ||
}, | ||
"additionalProperties": false | ||
} | ||
] | ||
} |