https://github.com/hitthecodelabs/badge_documentation
How to automate badge URLs into HTML <img> tags.
https://github.com/hitthecodelabs/badge_documentation
Last synced: about 1 year ago
JSON representation
How to automate badge URLs into HTML <img> tags.
- Host: GitHub
- URL: https://github.com/hitthecodelabs/badge_documentation
- Owner: hitthecodelabs
- License: mit
- Created: 2023-09-20T07:14:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-20T08:44:34.000Z (over 2 years ago)
- Last Synced: 2025-02-04T11:44:05.921Z (over 1 year ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Badge_Documentation
## Description
This repository contains a Jupyter Notebook that handles badge URLs stored in a `.txt` file. The notebook reads the URLs, filters out duplicates, formats them into HTML `![]()
` tags, sorts them alphabetically by badge name, and prints out the sorted badges both in HTML format and as a list separated by pipes.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Installation
1. Clone this repository to your local machine.
```bash
# Clone the repository
git clone https://github.com/hitthecodelabs/Badge_Documentation.git
# Navigate into the directory
cd My_Badge_Documentation
```
2. Open the Jupyter Notebook (badges_script.ipynb) in Jupyter Notebook or Jupyter Lab to proceed.
## Usage
Make sure you have a file named `badges.txt` in the same directory as the Jupyter Notebook. This `.txt` file should contain URLs for the badges you want to document.
Run all the cells in the notebook to generate HTML `![]()
` tags for each unique badge and sort them alphabetically.
## Project Structure
- `badges_script.ipynb`: Jupyter Notebook that contains the code for badge processing.
- `badges.txt`: Text file containing badge URLs.
## Contributing
If you find any bugs or have feature requests, feel free to open an issue. Pull requests are also welcome.
## License
This project is licensed under the terms of the MIT License. See [LICENSE](./LICENSE) for more information.