{"id":13494816,"url":"https://github.com/Guts/mkdocs-rss-plugin","last_synced_at":"2025-03-28T15:31:58.151Z","repository":{"id":39083162,"uuid":"277554161","full_name":"Guts/mkdocs-rss-plugin","owner":"Guts","description":"MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta).","archived":false,"fork":false,"pushed_at":"2025-03-03T18:46:30.000Z","size":1604,"stargazers_count":101,"open_issues_count":18,"forks_count":27,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-25T10:03:14.043Z","etag":null,"topics":["mkdocs","mkdocs-plugin","mkdocs-rss-plugin","pypi","rss-generator"],"latest_commit_sha":null,"homepage":"https://guts.github.io/mkdocs-rss-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Guts.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"guts","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":"GeoJulien","issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2020-07-06T13:48:11.000Z","updated_at":"2025-03-24T03:39:33.000Z","dependencies_parsed_at":"2024-01-13T22:43:16.093Z","dependency_job_id":"d0c16df0-47fe-420c-aa86-8cc018f32ee6","html_url":"https://github.com/Guts/mkdocs-rss-plugin","commit_stats":{"total_commits":726,"total_committers":17,"mean_commits":"42.705882352941174","dds":0.2286501377410468,"last_synced_commit":"a44922c53fc09fae8c278eb67ffc6465c2ff8f2a"},"previous_names":[],"tags_count":53,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Fmkdocs-rss-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Fmkdocs-rss-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Fmkdocs-rss-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Fmkdocs-rss-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Guts","download_url":"https://codeload.github.com/Guts/mkdocs-rss-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246053793,"owners_count":20716257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-plugin","mkdocs-rss-plugin","pypi","rss-generator"],"created_at":"2024-07-31T19:01:28.529Z","updated_at":"2025-03-28T15:31:58.137Z","avatar_url":"https://github.com/Guts.png","language":"Python","readme":"# MkDocs RSS plugin\n\n[![PyPi version badge](https://badgen.net/pypi/v/mkdocs-rss-plugin)](https://pypi.org/project/mkdocs-rss-plugin/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-rss-plugin)](https://pypi.org/project/mkdocs-rss-plugin/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-rss-plugin)](https://pypi.org/project/mkdocs-rss-plugin/)\n\n[![codecov](https://codecov.io/gh/Guts/mkdocs-rss-plugin/branch/main/graph/badge.svg?token=A0XPLKiwiW)](https://codecov.io/gh/Guts/mkdocs-rss-plugin)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![flake8](https://img.shields.io/badge/linter-flake8-green)](https://flake8.pycqa.org/)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat\u0026labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Guts/mkdocs-rss-plugin/master.svg)](https://results.pre-commit.ci/latest/github/Guts/mkdocs-rss-plugin/master)\n[![📚 Documentation](https://github.com/Guts/mkdocs-rss-plugin/actions/workflows/documentation.yml/badge.svg)](https://github.com/Guts/mkdocs-rss-plugin/actions/workflows/documentation.yml)\n\nA plugin for [MkDocs](https://www.mkdocs.org), the static site generator, which creates [RSS 2.0](https://wikipedia.org/wiki/RSS) and [JSON Feed 1.1](https://www.jsonfeed.org/version/1.1/) feeds using the creation and modification dates from [git log](https://git-scm.com/docs/git-log) and page metadata ([YAML frontmatter](https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data)).\n\n## Installation\n\n```sh\npip install mkdocs-rss-plugin\n```\n\n## Usage\n\nMinimal [`mkdocs.yml` configuration](https://www.mkdocs.org/user-guide/configuration/#project-information):\n\n```yaml\nsite_description: required. Used as feed mandatory channel description.\nsite_name: required. Used as feed mandatory channel title and items source URL label.\nsite_url: required. Used to build feed items URLs.\n```\n\nMinimal plugin option:\n\n```yaml\nplugins:\n  - rss\n```\n\nFull options:\n\n```yaml\nplugins:\n  - rss:\n      abstract_chars_count: 160  # -1 for full content\n      abstract_delimiter: \u003c!-- more --\u003e\n      categories:\n        - tags\n      comments_path: \"#__comments\"\n      date_from_meta:\n        as_creation: \"date\" # means from page.meta.date\n        as_update: \"git\" # means from git log\n        datetime_format: \"%Y-%m-%d %H:%M\"\n        default_time: \"09:30\"\n        default_timezone: Europe/Paris\n      enabled: true\n      feed_description: \"My custom feed description\"  # MkDocs site_description: will be used if this key is not present\n      feeds_filenames:\n        json_created: feed_json_created.json\n        json_updated: feed_json_updated.json\n        rss_created: feed_rss_created.xml\n        rss_updated: feed_rss_updated.xml\n      feed_title: \"My custom feed title\"  # MkDocs site_name: will be used if this key is not present\n      feed_ttl: 1440\n      image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png\n      json_feed_enabled: true\n      length: 20\n      match_path: \".*\"\n      pretty_print: false\n      rss_feed_enabled: true\n      url_parameters:\n        utm_source: \"documentation\"\n        utm_medium: \"RSS\"\n        utm_campaign: \"feed-syndication\"\n      use_git: true\n      use_material_blog: true\n      use_material_social_cards: true\n```\n\nFor further information, [see the user documentation](https://guts.github.io/mkdocs-rss-plugin/).\n\nFollowing initiative from the author of Material for MkDocs, this plugin provides its own JSON schema to validate configuration: [source](https://github.com/Guts/mkdocs-rss-plugin/blob/main/docs/schema.json) - [documentation](https://guts.github.io/mkdocs-rss-plugin/schema.json).\n\n## Development\n\nClone the repository:\n\n```sh\n# install development dependencies\npython -m pip install -U -r requirements/development.txt\n# alternatively: pip install -e .[dev]\n\n# install project as editable\npython -m pip install -e .\n\n# install git hooks\npre-commit install\n```\n\nThen follow the [contribution guidelines](CONTRIBUTING.md).\n\n### Run the tests\n\n```sh\n# install development dependencies\npython -m pip install -U -r requirements/testing.txt\n# alternatively: pip install -e .[test]\n\n# run tests\npytest\n```\n\n### Build the documentation\n\n```sh\n# install dependencies for documentation\npython -m pip install -U -r requirements/documentation.txt\n# alternatively: pip install -e .[doc]\n\n# build the documentation\nmkdocs build\n```\n\n### Release workflow\n\n1. Fill the `CHANGELOG.md`\n1. Change the version number in `__about__.py`\n1. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m \"New awesome feature\"`\n1. Push tag to main branch: `git push origin 0.3.0`\n","funding_links":["https://github.com/sponsors/guts","https://liberapay.com/GeoJulien"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGuts%2Fmkdocs-rss-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGuts%2Fmkdocs-rss-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGuts%2Fmkdocs-rss-plugin/lists"}