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.

Sign up for GitHub

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

Documentation: fix anchors in JSON schema #220

Merged
merged 3 commits into from
Dec 13, 2023
Merged

Documentation: fix anchors in JSON schema #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10e6e87
docs: homogeneize permalinks slug
Guts Dec 13, 2023
50bcc7f
docs: fix achors in markdownDescription
Guts Dec 13, 2023
38d7636
fix: test against local img
Guts Dec 13, 2023
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
24 changes: 12 additions & 12 deletions docs/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@
"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",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#abstract_chars_count-item-description-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",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#categories-item-categories",
"type": "array",
"default": null,
"items": {
Expand All @@ -35,14 +35,14 @@
},
"comments_path": {
"title": "Part of URL to the items' comment div.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#item-comments-path",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#comments_path-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",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#date_from_meta-override-dates-from-git-log-with-pagemeta",
"type": "object",
"default": null,
"properties": {
Expand Down Expand Up @@ -88,50 +88,50 @@
},
"enabled": {
"title": "Enable/Disable plugin",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#enabled-enablingdisabling-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",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#feed_ttl-feeds-cache-time",
"type": "integer",
"default": 1440
},
"image": {
"title": "Feed channel illustration",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#channel-image",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#image-set-the-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",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#length-number-of-items-to-include-in-feed",
"type": "integer",
"default": 20
},
"match_path": {
"title": "Regex match pattern to filter pages.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#filter-pages",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#match_path-filter-pages-to-include-in-feed",
"type": "string",
"default": ".*"
},
"pretty_print": {
"title": "Minify/Prettify output",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#prettified-output",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#pretty_print-prettified-xml",
"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",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#url_parameters-additional-url-parameters",
"type": "object",
"default": null
},
"use_git": {
"title": "Enable/Disable git use.",
"description": "Disable it if you want to use only page.meta values.",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin",
"markdownDescription": "https://guts.github.io/mkdocs-rss-plugin/configuration/#use_git-enabledisable-git-log",
"type": "boolean",
"default": true
}
Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ markdown_extensions:
case: lower
- toc:
permalink: "#"
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower

nav:
- Home: index.md
Expand Down Expand Up @@ -103,7 +106,6 @@ plugins:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL, true]
cache_dir: !ENV [MKDOCS_PLUGIN_SOCIAL_CACHE_DIR, .cache/plugins/social]
- termynal:
title: "Youpi"
prompt_literal_start:
- "$"
- ">"
Expand Down
2 changes: 1 addition & 1 deletion tests/test_rss_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def test_build_url(self):
def test_local_image_ok(self):
"""Test local image length calculation."""
img_length = self.plg_utils.get_local_image_length(
page_path="docs/index.md", path_to_append="rss_icon.svg"
page_path="docs/index.md", path_to_append="assets/rss_icon.svg"
)
self.assertIsInstance(img_length, int)

Expand Down