{"id":37141635,"url":"https://github.com/francarstens/docsify-breadcrumb","last_synced_at":"2026-01-14T16:37:39.620Z","repository":{"id":250372368,"uuid":"834279648","full_name":"FranCarstens/docsify-breadcrumb","owner":"FranCarstens","description":"a simple breadcrumb generator for docsify","archived":false,"fork":false,"pushed_at":"2024-10-18T13:29:45.000Z","size":207,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-13T01:10:16.018Z","etag":null,"topics":["docsify"],"latest_commit_sha":null,"homepage":"https://francarstens.github.io/docsify-breadcrumb/","language":"JavaScript","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/FranCarstens.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-26T20:43:13.000Z","updated_at":"2025-12-21T20:13:15.000Z","dependencies_parsed_at":"2024-08-22T03:00:15.338Z","dependency_job_id":"bb237c55-592b-40fe-b411-a5b1dd3744a9","html_url":"https://github.com/FranCarstens/docsify-breadcrumb","commit_stats":null,"previous_names":["francarstens/docsify-breadcrumb"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/FranCarstens/docsify-breadcrumb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranCarstens%2Fdocsify-breadcrumb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranCarstens%2Fdocsify-breadcrumb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranCarstens%2Fdocsify-breadcrumb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranCarstens%2Fdocsify-breadcrumb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FranCarstens","download_url":"https://codeload.github.com/FranCarstens/docsify-breadcrumb/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranCarstens%2Fdocsify-breadcrumb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28426112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T16:32:27.303Z","status":"ssl_error","status_checked_at":"2026-01-14T16:28:36.419Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docsify"],"created_at":"2026-01-14T16:37:39.054Z","updated_at":"2026-01-14T16:37:39.607Z","avatar_url":"https://github.com/FranCarstens.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docsify Breadcrumb\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://docsify.js.org/_media/icon.svg\" /\u003e\n  \u003cbr /\u003e\n  \u003ccode\u003edocsify-breadcrumb\u003c/code\u003e\n\u003c/p\u003e\n\nThis is a plugin for [Docsify](https://docsify.js.org/#/) that adds a breadcrumb to the top of each page.\n\n## Features\n\n`docsify-breadcrumb` adds a small, accessible breadcrumb to the top of each page. It supports a number of configuration options and can be styled to match your Docsify theme.\n\nThe breadcrumb is represented by human readable parts of the url combined using a configurable separator. Each part links to its section. The final breadcrumb reflects the title of the current page.\n\n**For example:**\n\n`/articles/books-and-more/adventure/`\n\n![Breadcrumb Example](https://raw.githubusercontent.com/FranCarstens/docsify-breadcrumb/main/assets/example.png)\n\n\n## Basic Usage\n\nAdd the following to your `index.html` below your Docsify script tag:\n\n```html\n\u003c!-- Adds the breadcrumb JavaScript --\u003e\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/docsify-breadcrumb@latest/dist/index.min.js\"\u003e\u003c/script\u003e\n```\n\n## Add default styling\n\nAdd the following to your `index.html` just before the closing `\u003c/head\u003e` tag:\n\n```html\n\u003c!-- Adds the default breadcrumb styling --\u003e\n\u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/docsify-breadcrumb@latest/dist/breadcrumb.min.css\"\u003e\n```\n\n## Configuration\n\n`docsify-breadcrumb` allows some customization through the `window.$docsify` object. Here are the available options:\n\n| Option      | Type    | Default                         | Description                                                                                                                                                                                                                                                                 |\n| ----------- | ------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `showHome`  | Boolean | `false`                         | Show the home link when you're on the home page.                                                                                                                                                                                                                            |\n| `homeText`  | String  | `'Home'`                        | The text for the home link.                                                                                                                                                                                                                                                 |\n| `separator` | String  | `' › '`                         | The separator between each breadcrumb item.                                                                                                                                                                                                                                 |\n| `casing`    | String  | `'capitalize'`                  | The casing of the breadcrumb items. Options follow the CSS standard for `text-transform`. E.g., `'capitalize'`, `'uppercase'`, and `'lowercase'`. See [text-transform](https://developer.mozilla.org/en-US/docs/Web/CSS/text-transform) documentation for more information. |\n| `linkColor` | String  | `'var(--theme-color, #42b983)'` | The color of the breadcrumb links. This can be any valid CSS color value.                                                                                                                                                                                                   |\n| `size`      | String  | `'small'`                       | The size of the breadcrumb links. Options are `'small'` (`0.75em`), `'smaller'` (`0.83em`), and `'normal'` (`1em`). This can easily be overridden with custom CSS.                                                                                                          |\n\n### Example\n\nYou do not have to include options where you want to use the default values.:\n\n```html\n\u003cscript\u003e\n  window.$docsify = {\n    breadcrumb: {\n      showHome: true,\n      homeText: 'Home',\n      separator: ' \u0026rsaquo; ',\n      casing: 'capitalize',\n      linkColor: 'var(--theme-color, #42b983)',\n      size: 'small'\n    }\n  }\n\u003c/script\u003e\n```\n\n---\n\nInspired by [the breadcrumb work](https://github.com/docsifyjs/docsify/issues/2016) of [Abhilash](https://github.com/abpanic)\n\n[![](https://data.jsdelivr.com/v1/package/npm/docsify-breadcrumb/badge)](https://www.jsdelivr.com/package/npm/docsify-breadcrumb)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrancarstens%2Fdocsify-breadcrumb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrancarstens%2Fdocsify-breadcrumb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrancarstens%2Fdocsify-breadcrumb/lists"}