Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zheng-bote/rz-breadcrumbs
A Web Component for automatic Breadcrumbs
https://github.com/zheng-bote/rz-breadcrumbs
javascript webcomponent
Last synced: about 1 month ago
JSON representation
A Web Component for automatic Breadcrumbs
- Host: GitHub
- URL: https://github.com/zheng-bote/rz-breadcrumbs
- Owner: Zheng-Bote
- License: mit
- Created: 2024-09-14T15:15:44.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:55:59.000Z (about 2 months ago)
- Last Synced: 2024-09-26T07:21:44.386Z (about 2 months ago)
- Topics: javascript, webcomponent
- Language: HTML
- Homepage:
- Size: 406 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
rz-breadcrumbs
A Web Component for automatic Breadcrumbs
[Report Issue](https://github.com/Zheng-Bote/rz-breadcrumbs/issues) [Request Feature](https://github.com/Zheng-Bote/rz-breadcrumbs/pulls)
[](https://choosealicense.com/licenses/mit/)
**Table of Contents**
- [Description](#description)
- [Features](#features)
- [Status](#status)
- [Repo](#repo)
- [Readme](#readme)
- [Markdown files](#markdown-files)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [folder structure](#folder-structure)
- [Usage/Examples](#usageexamples)
- [API Reference](#api-reference)
- [Parameters](#parameters)
- [Documentation](#documentation)
- [Screenshots](#screenshots)
- [Authors and License](#authors-and-license)
- [License](#license)
- [Authors](#authors)
- [Code Contributors](#code-contributors)
# Description
A Web Component for automatic Breadcrumbs.
### Features
- \[x] MIT license
- \[x] works as designed
- \[ ] no bugs
- \[x] plain Vanilla
- \[x] some more or less usefull Github Actions
## Status
### Repo
### Readme
[](https://github.com/Zheng-Bote/rz-breadcrumbs/actions/workflows/repo-create_tree_readme.yml)
[](https://github.com/Zheng-Bote/rz-breadcrumbs/actions/workflows/repo-actions_docu.yml)
[](https://github.com/Zheng-Bote/rz-breadcrumbs/actions/workflows/repo-call_Readme.yml)
### Markdown files
[](https://github.com/Zheng-Bote/rz-breadcrumbs/actions/workflows/repo-create_doctoc_md.yml)
create ToC in Markdown files in folders
- .github/actions/\*\*
- .github/workflows/\*\*
- dist/\*\*
- docs/\*\*
# Installation
copy the folder `assets` in your webfolder and make it readable for your webserver
## Dependencies
modern browser with enabled Javascript
## folder structure
```
.
├── .github
│ ├── actions
│ │ └── doctoc
│ │ ├── README.md
│ │ ├── action.yml
│ │ └── dist
│ │ ├── index.js
│ │ ├── index.js.map
│ │ ├── licenses.txt
│ │ └── sourcemap-register.js
│ └── workflows
│ ├── repo-actions_docu.yml
│ ├── repo-call_Readme.yml
│ ├── repo-create_doctoc.yml_
│ ├── repo-create_doctoc_md.yml
│ └── repo-create_tree_readme.yml
├── LICENSE
├── README.md
├── assets
│ ├── css
│ │ └── rz-breadcrumbs.css
│ ├── img
│ │ └── screenshot_20240914_rz-breadcrumbs.png
│ └── js
│ └── rz-breadcrumbs.js
├── favicon.ico
├── index.html
├── tree.bak
└── urltest1
├── index.html
└── urltest2
├── index.html
└── urltest3
└── index.html
12 directories, 22 files
```
## Usage/Examples
```HTML
```
```HTML
rz-breadcrumbs
web component rz-breadcrumbs example
urltest1
urltest2
urltest3
```
# API Reference
## Parameters
_currently no parameters_
# Documentation
see:
- `assets/js/rz-breadcrumbs.js`
- `assets/css/rz-breadcrumbs.css`
## Screenshots
# Authors and License
## License
MIT License
Copyright (c) 2024 ZHENG Robert
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
https://choosealicense.com/licenses/mit/
## Authors
- [](https://www.github.com/Zheng-Bote)
### Code Contributors
[](https://www.github.com/Zheng-Bote)
:vulcan_salute: