{"id":18551929,"url":"https://github.com/baraja-core/sitemap","last_synced_at":"2025-05-15T11:10:53.391Z","repository":{"id":48404192,"uuid":"299081619","full_name":"baraja-core/sitemap","owner":"baraja-core","description":"Simple sitemap generator with robust and performance implementation.","archived":false,"fork":false,"pushed_at":"2022-09-08T13:41:10.000Z","size":55,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T13:14:12.537Z","etag":null,"topics":["robust","sitemap","sitemap-generator","sitemap-xml","urlloader"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/baraja-core.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-27T17:18:15.000Z","updated_at":"2023-09-08T18:12:56.000Z","dependencies_parsed_at":"2022-08-21T09:20:26.568Z","dependency_job_id":null,"html_url":"https://github.com/baraja-core/sitemap","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baraja-core%2Fsitemap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baraja-core%2Fsitemap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baraja-core%2Fsitemap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baraja-core%2Fsitemap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/baraja-core","download_url":"https://codeload.github.com/baraja-core/sitemap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254328389,"owners_count":22052633,"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":["robust","sitemap","sitemap-generator","sitemap-xml","urlloader"],"created_at":"2024-11-06T21:11:09.163Z","updated_at":"2025-05-15T11:10:48.881Z","avatar_url":"https://github.com/baraja-core.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sitemap generator\n=================\n\n![Integrity check](https://github.com/baraja-core/sitemap/workflows/Integrity%20check/badge.svg)\n\nSimple sitemap generator with robust and performance implementation.\n\n- Generates a standardized site map in XML format,\n- Allows custom implementation of UrlLoader and specification of custom link sources,\n- The generated map is automatically cached and updated without the need to use cron.\n\n📦 Installation\n---------------\n\nIt's best to use [Composer](https://getcomposer.org) for installation, and you can also find the package on\n[Packagist](https://packagist.org/packages/baraja-core/sitemap) and\n[GitHub](https://github.com/baraja-core/sitemap).\n\nTo install, simply use the command:\n\n```shell\n$ composer require baraja-core/sitemap\n```\n\nYou can use the package manually by creating an instance of the internal classes, or register a DIC extension to link the services directly to the Nette Framework.\n\nBasic description\n------------------\n\nThe package automatically generates a site map as a `sitemap.xml` file with the following structure:\n\n```xml\n\u003curlset xmlns = \"http://www.sitemaps.org/schemas/sitemap/0.9\"\u003e\n    \u003curl\u003e\n        \u003cloc\u003e\n            https://... // Here will be the whole absolute path\n        \u003c/loc\u003e\n        \u003cchangefreq\u003eweekly\u003c/changefreq\u003e\n        \u003cpriority\u003e0.5\u003c/priority\u003e\n    \u003c/url\u003e\n\u003c/urlset\u003e\n```\n\nURLs are retrieved from the abstract `SitemapUrlLoader` service, which can be overloaded and otherwise implemented. UrlLoader returns the entity field `SitemapItems[]` with the `getUrls()` method.\n\nIt adds its own presenter to the administration, which shows the current form and structure of the file.\n\nInstallation\n------------\n\nComposer:\n\n```shel\n$ composer require baraja-core/sitemap\n```\n\nThe routing rule and services are registered automatically.\n\nAfter installation, you must define an UrlLoader in the package, which gets a list of all available URLs and passes it on for rendering. You can use another existing library as the UrlLoader.\n\nGetting a list of URLs\n----------------------\n\nThe package does not include the default implementation of UrlLoader, and each project must implement it itself.\n\nThe class must contain a public `getUrls()` method that returns an array of `SitemapItem[]` instances.\n\nGetting sitemap + cache\n-----------------------\n\nThe package does not create any physical sitemap file, because it runs a PHP script with each request. In order not to always have to perform complex mapping, the package itself will use a cache with a default validity of 5 minutes.\n\nThe cache length setting can be affected by the `neon` configuration file:\n\n```yaml\nsitemap:\n    cacheExpirationTime: '20 minutes'\n```\n\n📄 License\n-----------\n\n`baraja-core/sitemap` is licensed under the MIT license. See the [LICENSE](https://github.com/baraja-core/sitemap/blob/master/LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbaraja-core%2Fsitemap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbaraja-core%2Fsitemap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbaraja-core%2Fsitemap/lists"}