{"id":13696055,"url":"https://github.com/pelican-plugins/sitemap","last_synced_at":"2025-04-10T04:32:50.532Z","repository":{"id":41145460,"uuid":"257318292","full_name":"pelican-plugins/sitemap","owner":"pelican-plugins","description":"Generates a site map for Pelican-powered sites","archived":false,"fork":false,"pushed_at":"2024-04-02T09:16:00.000Z","size":62,"stargazers_count":42,"open_issues_count":8,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-09T02:50:50.076Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pelican-plugins.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"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},"funding":{"github":"justinmayer","custom":"https://donate.getpelican.com","liberapay":"pelican"}},"created_at":"2020-04-20T15:08:25.000Z","updated_at":"2024-04-15T14:52:02.488Z","dependencies_parsed_at":"2024-04-15T14:51:59.091Z","dependency_job_id":"d1f61996-0ff6-4e7d-8b21-b16aecc2a8aa","html_url":"https://github.com/pelican-plugins/sitemap","commit_stats":{"total_commits":58,"total_committers":20,"mean_commits":2.9,"dds":0.4655172413793104,"last_synced_commit":"8e3714412c410edadb3f059329413adc28870944"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fsitemap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fsitemap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fsitemap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fsitemap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pelican-plugins","download_url":"https://codeload.github.com/pelican-plugins/sitemap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248157657,"owners_count":21057048,"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":[],"created_at":"2024-08-02T18:00:35.915Z","updated_at":"2025-04-10T04:32:50.510Z","avatar_url":"https://github.com/pelican-plugins.png","language":"Python","funding_links":["https://github.com/sponsors/justinmayer","https://donate.getpelican.com","https://liberapay.com/pelican"],"categories":["Plugins"],"sub_categories":["Migrated to new architecture"],"readme":"Sitemap\n=======\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/sitemap/main.yml?branch=main)](https://github.com/pelican-plugins/sitemap/actions)\n[![PyPI Version](https://img.shields.io/pypi/v/pelican-sitemap)](https://pypi.org/project/pelican-sitemap/)\n[![Downloads](https://img.shields.io/pypi/dm/pelican-sitemap)](https://pypi.org/project/pelican-sitemap/)\n![License](https://img.shields.io/pypi/l/pelican-sitemap?color=blue)\n\nThis [Pelican][] plugin generates a site map in plain-text or XML format. You can use the `SITEMAP` variable in your settings file to configure the behavior of the plugin.\n\nInstallation\n------------\n\nThis plugin can be installed via:\n\n    python -m pip install pelican-sitemap\n\nAs long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `sitemap` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.\n\nUsage\n-----\n\nThe `SITEMAP` setting must be a Python dictionary and can contain these keys:\n\n* `format`, which sets the output format of the plugin (`xml` or `txt`)\n\n* `priorities`, which is a dictionary with three keys:\n\n    - `articles`, the priority for the URLs of the articles and their translations\n\n    - `pages`, the priority for the URLs of the static pages\n\n    - `indexes`, the priority for the URLs of the index pages, such as tags, author pages, categories indexes, archives, etc.\n\n    All the values of this dictionary must be decimal floating-point numbers between `0` and `1`, such as `0.3` or `0.7`.\n\n* `changefreqs`, which is a dictionary with three items:\n\n    - `articles`, the update frequency of the articles\n\n    - `pages`, the update frequency of the pages\n\n    - `indexes`, the update frequency of the index pages\n\n    Valid frequency values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly` and `never`.\n\n* `exclude`, which is a list of regular expressions that will be used to exclude matched URLs from the sitemap if *any* of them match. For example:\n\n```python\nSITEMAP = {\n    \"exclude\": [\n        \"^/noindex/\",  # starts with \"/noindex/\"\n        \"/tag/\",       # contains \"/tag/\"\n        \"\\.json$\",     # ends with \".json\"\n    ]\n}\n```\n\nIf a key is missing or a value is incorrect, it will be replaced with the default value.\n\nYou can also exclude an individual URL by adding metadata to it, setting `private` to `True`.\n\nThe sitemap is saved in: `\u003coutput_path\u003e/sitemap.\u003cformat\u003e`\n\n\u003e **Note:** `priorities` and `changefreqs` are information for search engines and are only used in the XML site maps. For more information, see: \u003chttps://www.sitemaps.org/protocol.html#xmlTagDefinitions\u003e\n\n**Example**\n\nHere is an example configuration (it is also the default settings):\n\n```python\nSITEMAP = {\n    \"format\": \"xml\",\n    \"priorities\": {\n        \"articles\": 0.5,\n        \"indexes\": 0.5,\n        \"pages\": 0.5\n    },\n    \"changefreqs\": {\n        \"articles\": \"monthly\",\n        \"indexes\": \"daily\",\n        \"pages\": \"monthly\"\n    }\n}\n```\n\nUsing Metadata\n--------------\n\nIn addition to applying a configuration to all articles/pages using the `SITEMAP` setting, `ChangeFreq` and `Priority` can also be specified as metadata for individual articles/pages. The same restrictions on the values apply:\n\n* Valid options for `ChangeFreq` are  `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly` and `never`.\n* Valid options for `Priority` must be a decimal number between `0` and `1`.\n\n**Example**\n\nFollowing is an example of using sitemap-related metadata in a Markdown file:\n\n```\nTitle: Frequently Changed Article\nChangeFreq: daily\nPriority: 0.3\n\nThis is the article content.\n```\n\nContributing\n------------\n\nContributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on [existing issues][].\n\nTo start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.\n\n[Pelican]: https://github.com/getpelican/pelican\n[existing issues]: https://github.com/pelican-plugins/sitemap/issues\n[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html\n\nLicense\n-------\n\nThis project is licensed under the [AGPL-3.0](http://www.gnu.org/licenses/agpl-3.0-standalone.html) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpelican-plugins%2Fsitemap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpelican-plugins%2Fsitemap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpelican-plugins%2Fsitemap/lists"}