{"id":19692160,"url":"https://github.com/getgrav/grav-plugin-breadcrumbs","last_synced_at":"2025-04-29T09:31:22.329Z","repository":{"id":19318166,"uuid":"22556331","full_name":"getgrav/grav-plugin-breadcrumbs","owner":"getgrav","description":"Grav Breadcrumbs Plugin","archived":false,"fork":false,"pushed_at":"2023-10-05T13:00:48.000Z","size":444,"stargazers_count":18,"open_issues_count":14,"forks_count":17,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2025-04-19T07:43:47.276Z","etag":null,"topics":["breadcrumbs","grav","grav-plugin"],"latest_commit_sha":null,"homepage":"https://getgrav.org","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/getgrav.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2014-08-02T20:00:29.000Z","updated_at":"2025-03-15T20:57:36.000Z","dependencies_parsed_at":"2023-09-26T11:03:10.243Z","dependency_job_id":"fef8c0a4-f645-4483-bf8e-2181b5efaab8","html_url":"https://github.com/getgrav/grav-plugin-breadcrumbs","commit_stats":{"total_commits":61,"total_committers":14,"mean_commits":4.357142857142857,"dds":0.5081967213114754,"last_synced_commit":"25299d791dbd77dcb48296d57d4a9d1a6341e3f3"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-breadcrumbs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-breadcrumbs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-breadcrumbs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-breadcrumbs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getgrav","download_url":"https://codeload.github.com/getgrav/grav-plugin-breadcrumbs/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251160441,"owners_count":21545364,"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":["breadcrumbs","grav","grav-plugin"],"created_at":"2024-11-11T19:12:29.162Z","updated_at":"2025-04-29T09:31:21.880Z","avatar_url":"https://github.com/getgrav.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Grav Breadcrumbs Plugin\n\n![Breadcrumbs](assets/readme_1.png)\n\n`Breadcrumbs` is a [Grav](http://github.com/getgrav/grav) plugin that adds links to the previous pages (following the hierarchical structure).\nIt is particularly useful if you are using Grav to run a blog.\n\n# Installation\n\nInstalling the Breadcrumbs plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file. \n\n## GPM Installation (Preferred)\n\nThe simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line).  From the root of your Grav install type:\n\n    bin/gpm install breadcrumbs\n\nThis will install the Breadcrumbs plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/breadcrumbs`.\n\n## Manual Installation\n\nTo install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `breadcrumbs`. You can find these files either on [GitHub](https://github.com/getgrav/grav-plugin-breadcrumbs) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).\n\nYou should now have all the plugin files under\n\n    /your/site/grav/user/plugins/breadcrumbs\n\n\u003e\u003e NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav), the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) plugins, and a theme to be installed in order to operate.\n\n# Usage\n\nThe `breadcrumbs` plugin doesn't require any configuration. The moment you install it, it is ready to use.\n\nSomething you might want to do is to override the look and feel of the breadcrumbs, and with Grav it is super easy.\n\nCopy the template file [breadcrumbs.html.twig](templates/partials/breadcrumbs.html.twig) into the `templates` folder of your custom theme, and that is it. \n\n```\n/your/site/grav/user/themes/custom-theme/templates/partials/breadcrumbs.html.twig\n```\n\nYou can now edit the override and tweak it however you prefer.\n\n## Per-page Settings\n\nThe following options are available for use in a page's YAML frontmatter, placed within the `breadcrumbs` mapping:\n\n| Option      | Default | Values            | Description                                                                          |\n|-------------|---------|-------------------|--------------------------------------------------------------------------------------|\n| `max_depth` | `true`  | `true` or `false` | Determines whether breadcrumbs for pages beneath the current page will be generated. |\n\n### Example Per-page Settings\n\n```yaml\n---\ntitle: Some page you wrote\nbreadcrumbs:\n  may_descend: false # Breadcrumbs will not be generated for pages underneath this one.\n---\n```\n\n# Updating\n\nAs development for the Breadcrumbs plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating Breadcrumbs is easy, and can be done through Grav's GPM system, as well as manually.\n\n## GPM Update (Preferred)\n\nThe simplest way to update this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:\n\n    bin/gpm update breadcrumbs\n\nThis command will check your Grav install to see if your Breadcrumbs plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The plugin will automatically update and clear Grav's cache.\n\n## Manual Update\n\nManually updating Breadcrumbs is pretty simple. Here is what you will need to do to get this done:\n\n* Delete the `your/site/user/plugins/breadcrumbs` directory.\n* Download the new version of the Breadcrumbs plugin from either [GitHub](https://github.com/getgrav/grav-plugin-breadcrumbs) or [GetGrav.org](http://getgrav.org/downloads/plugins#extras).\n* Unzip the zip file in `your/site/user/plugins` and rename the resulting folder to `breadcrumbs`.\n* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing `bin/grav clear-cache`.\n\n\u003e Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/plugins`) will remain intact.\n\n## Configuration\n\nSimply copy the `user/plugins/breadcrumbs/breadcrumbs.yaml` into `user/config/plugins/breadcrumbs.yaml` and make your modifications.\n\n```\nenabled: true\nshow_all: true\nbuilt_in_css: true\ninclude_home: true\ninclude_current: true\nicon_home: ''\nicon_divider_classes: 'fa fa-angle-right'\nlink_trailing: false\n```\n\nOptions are pretty self explanatory.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgrav%2Fgrav-plugin-breadcrumbs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetgrav%2Fgrav-plugin-breadcrumbs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgrav%2Fgrav-plugin-breadcrumbs/lists"}