https://github.com/jenkinsci/oss-symbols-api-plugin

IT tools symbols API plugin. Provide to other plugin symbols of common IT tools
https://github.com/jenkinsci/oss-symbols-api-plugin

symbols ui ux

Last synced: 7 days ago
JSON representation

IT tools symbols API plugin. Provide to other plugin symbols of common IT tools

• Host: GitHub
• URL: https://github.com/jenkinsci/oss-symbols-api-plugin
• Owner: jenkinsci
• License: mit
• Created: 2024-08-29T07:20:30.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-09-17T13:05:55.000Z (16 days ago)
• Last Synced: 2024-09-23T19:03:46.811Z (10 days ago)
• Topics: symbols, ui, ux
• Language: Java
• Homepage: https://plugins.jenkins.io/oss-symbols-api/
• Size: 380 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# IT Tools Symbols API Plugin

Jenkins API Plugin that provide logo of common IT tools also known as "symbols", for your Jenkins plugins.

[![Build Status](https://ci.jenkins.io/buildStatus/icon?job=Plugins/oss-symbols-api-plugin/main)](https://ci.jenkins.io/job/plugins/job/oss-symbols-api-plugin/)

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/oss-symbols-api.svg)](https://plugins.jenkins.io/oss-symbols-api/)

[![GitHub release](https://img.shields.io/github/release/jenkinsci/oss-symbols-api-plugin.svg?label=changelog)](https://github.com/jenkinsci/oss-symbols-api-plugin/releases/latest)

[![Contributors](https://img.shields.io/github/contributors/jenkinsci/oss-symbols-api-plugin.svg)](https://github.com/jenkinsci/oss-symbols-api-plugin/graphs/contributors)

## Usage

This plugin provides some tools logo of common IT tools also known as "symbols", for your Jenkins plugins.

Source of the SVG are from

- https://github.com/cdfoundation/artwork

- https://github.com/cncf/artwork

- https://github.com/ossf/artwork

- https://github.com/sigstore/community

- https://github.com/openrewrite

- https://www.openid.net

- https://testcontainers.com

- https://www.wiremock.io

- https://mariadb.com

- https://www.postgresql.org

- https://github.com/opencontainers/opencontainers.org

- https://www.pulumi.com/brand/

All icons are trademarks of their respective owners. The use of these trademarks does not indicate endorsement of the trademark holder, nor vice versa.

Refer to the previous list for the trademark policy of each organization.

Add the oss-symbols-api as dependency to your `pom.xml`:

To use a symbol, reference the icon as following:

### Jelly

```xml

```

### Groovy

```groovy

l.icon(src:"symbol-symbolName plugin-oss-symbols-api")

```

### Java

```java

@Override

public String getIconClassName() {

    return "symbol-symbolName plugin-oss-symbols-api";

}

```

One example is the usage with the badge plugin:

```groovy

node {

    addBadge(icon: "symbol-prometheus-icon-solid plugin-oss-symbols-api")

}

```

See https://plugins.jenkins.io/badge/ for more details.

Symbol supports standard and dark theme for solid icon

![](docs/badge.png)

![](docs/badge2.png)

Color is also supported

Other example include the `custom-folder-icon` and `customizable-header` plugins.

![](docs/folder_icon.png)

![](docs/header.png)

## LICENSE

Licensed under MIT, see [LICENSE](LICENSE.md)