diff --git a/.github/workflows/npm_publish.yml b/.github/workflows/npm_publish.yml new file mode 100644 index 00000000..dfcadfdb --- /dev/null +++ b/.github/workflows/npm_publish.yml @@ -0,0 +1,21 @@ +on: + release: + types: [released] +jobs: + publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + # "ref" specifies the branch to check out. + # "github.event.release.target_commitish" is a global variable and specifies the branch the release targeted + ref: ${{ github.event.release.target_commitish }} + - name: Use Node.js 12 + uses: actions/setup-node@v1 + with: + node-version: 12 + registry-url: https://registry.npmjs.org/ # Specifies the registry, this field is required! + - run: npm ci + - run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f560885d..35679750 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,6 +81,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Each .svg file contains one version of an icon in a 0 0 128 128 viewbox. You can use a service like resize-image for scaling the svg.
  • The svg element does not need the height and width attributes. However, if you do use it, ensure their values are either "128" or "128px". Ex: height="128"
  • Each .svg must use the fill attribute instead of using classes for colors. See here for more details.
  • +
  • The naming convention for the svg file is the following: (Icon name)-(original|plain|line)(-wordmark?).

  • @@ -259,4 +260,5 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
  • Ensure code quality is up to standard
  • Upload svgs to icomoon.io and take a screenshot to check that it looks good.
  • Comment on the PR so maintainers don't have to manually upload icon result.
  • +
  • Publishing a new release to npm; See #288
  • diff --git a/README.md b/README.md index e8101010..f9eaf40e 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,129 @@ -# Devicon v2 +

    + + GitHub release (latest by semver) + + + GitHub + + + GitHub contributors + + + GitHub branch checks state + + + GitHub issues by-label + + + GitHub Repo stars + +

    +
    +
    + + Devicon Logo + +
    + devicon aims to gather all logos representing development languages and tools. +
    +

    + Demo + · + Request Icon + · + Contribute +

    +
    -[https://devicons.github.io/devicon/](https://devicons.github.io/devicon/) +

    TL;DR;

    -Devicon aims to gather all logos representing development languages and tools. -Each icon comes in several versions: font/svg, original/plain/line, colored/not colored, wordmark/no wordmark. +```html + + -Devicon has 80+ icons and 200+ versions. And it's growing! + + +``` -See all available icons on the [new website](https://devicons.github.io/devicon/). +

    Table of Contents

    +
      +
    1. About the project
    2. +
    3. Getting started
    4. +
    5. Requesting icon
    6. +
    7. Contributing
    8. +
    9. Go build yourself
    10. +
    -## Icon requests -When you want to request a icon please feel feel to create a issue. See our [contribution guidelines](https://github.com/konpa/devicon/blob/master/CONTRIBUTING.md) for more information. +

    About the project

    +

    + Devicon aims to gather all logos representing development languages and tools. + Each icon comes in several versions: font/svg, original/plain/line, colored/not colored, wordmark/no wordmark. + Devicon has 150+ icons. And it's growing!
    +

    +

    + See the devicon.json or our website for complete and up to date reference of + all available icons. +

    + + All product names, logos, and brands are property of their respective owners. All company, product and service + names used in this website are for identification purposes only. Use of these names, logos, and brands does not + imply endorsement. + -## How to use -For a super fast setup go check [https://devicons.github.io/devicon/](https://devicons.github.io/devicon/) +

    Getting started

    +

    + For a super fast setup go check devicon.dev.
    + You can either use the raw svg icons or our devicon font (which is + also available via CDN). +

    -_2 ways of using devicon:_ +

    Use the devicon font (recommended)

    +

    + You can install devicon as a dependency to your project either with npm or yarn: +

    -#### SVG icons +```bash +npm install --save devicon +yarn add devicon +``` -- Copy/paste svg code (from the [svg folder](https://github.com/devicons/devicon/tree/master/icons) or the [project page](https://github.com/devicons/devicon) using your dev tool) +

    + If you don't want to use a package manager you can also download + and include devicon.min.css next to the font files to your project. + See devicon.dev for details about how to add devicon to your project via + a CDN. +

    +

    + After setting up you just have to include the stylesheet in your header + to get started: +

    + +```html + +``` + +

    Start using icons with <i>-tag

    + +```html + + + + + + + + + + + +``` + +

    + An alternate way to use devicon is by copy/paste the raw svg code + to your project. +

    +

    Copy/paste svg code (from the svg folder or the project page

    ```html @@ -29,7 +132,7 @@ _2 ways of using devicon:_ ``` -- Add css rules in your stylesheet +Add css rules in your stylesheet ```css .devicon-git-plain { max-width: 2em; @@ -41,71 +144,48 @@ _2 ways of using devicon:_ } ``` -#### Icons font +

    Requesting icon

    +

    + When you want to request a icon please feel feel to create a issue. See our contribution guidelines for more information. +

    -- Upload devicon.min.css and font files to your project -- Note: the `devicon.css` file is not the same as the `devicon.min.css`. It doesn't contain any colors or aliases. +

    Contributing

    +

    + We are happy for every contribution. Please have a look at our contribution guidelines + to see how you can contribute to this project. +

    -```html - -``` +

    Go build yourself

    +

    + Feel free to follow those steps when you want to build the font + by yourself. +

    +
    Prerequisites
    +

    Install gulp (and gulp plugins)

    -- Add icon using `` tag - -```html - - - - - - - - - - - -``` - -##### NPM and Bower packages - -You can install devicon as a dependency to your project either with NPM or Bower - -``` - // NPM - npm install --save devicon - - // Bower - bower install --save devicon -``` - -Final font is build with [Icomoon app](https://icomoon.io/) - -##### See the [devicon.json file](https://github.com/devicons/devicon/blob/master/devicon.json) or [devicon website](https://devicons.github.io/devicon/) for complete and up to date reference of icon's available versions. - -## Contribute - -Please have a look at the [CONTRIBUTING.md](https://github.com/devicons/devicon/blob/master/CONTRIBUTING.md) file - -Under [MIT Licence](https://github.com/devicons/devicon/blob/master/LICENSE) - -All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement. - -## Go build yourself -### Prerequisites -Install gulp (and gulp plugins) ```bash npm install ``` -### Build the font and export stylesheet -Open [icomoon app](https://icomoon.io/app/#/select) and import [icomoon.json](icomoon.json). Choose _yes_ when beeing asked + +
    Build the font and export stylesheet
    +Open icomoon.io and import icomoon.json. Choose yes when beeing asked if you like to restore the settings stored in the configuration file. -The next step is to click on **Generate font** and download the resulting archive. Extract it -contents and you will find a [fonts](./fonts) directory next to a `style.css`. Replace the content of the `fonts` folder, -rename the `style.css` to [devicon.css](./devicon.css) and follow the next step to build the final stylesheet. +The next step is to click on Generate font and download the resulting archive. Extract it +contents and you will find a fonts directory next to a style.css. Replace the content of the fonts folder, +rename the style.css to devicon.css and follow the next step to build the final stylesheet. + +
    Build and minify stylesheet
    +

    + Run the following command to build the resulting file devicon.min.css +

    -### Build and minify stylesheet -Run the following command to build the resulting file `devicon.min.css` ```bash npm run build-css ``` + +
    +
    + + +
    diff --git a/devicon.json b/devicon.json index fc9f1fbe..b5af5765 100644 --- a/devicon.json +++ b/devicon.json @@ -1832,6 +1832,27 @@ "color": "#0769ad", "aliases": [] }, + { + "name": "jupyter", + "tags": [ + "programming", + "language" + ], + "versions": { + "svg": [ + "original", + "original-wordmark", + "plain", + "plain-wordmark" + ], + "font": [ + "plain", + "plain-wordmark" + ] + }, + "color": "#F37726", + "aliases": [] + }, { "name": "kotlin", "tags": [ @@ -2099,7 +2120,7 @@ }, "color": "#6dd0c7", "aliases": [] - }, + }, { "name": "nestjs", "tags": [ @@ -2248,6 +2269,27 @@ } ] }, + { + "name": "ocaml", + "tags": [ + "programming", + "language" + ], + "versions": { + "svg": [ + "original", + "original-wordmark", + "plain", + "plain-wordmark" + ], + "font": [ + "plain", + "plain-wordmark" + ] + }, + "color": "#F18803", + "aliases": [] + }, { "name": "photoshop", "tags": [ diff --git a/icons/jupyter/jupyter-original-wordmark.svg b/icons/jupyter/jupyter-original-wordmark.svg new file mode 100644 index 00000000..12c379fe --- /dev/null +++ b/icons/jupyter/jupyter-original-wordmark.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/icons/jupyter/jupyter-original.svg b/icons/jupyter/jupyter-original.svg new file mode 100644 index 00000000..c33a2a85 --- /dev/null +++ b/icons/jupyter/jupyter-original.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/icons/jupyter/jupyter-plain-wordmark.svg b/icons/jupyter/jupyter-plain-wordmark.svg new file mode 100644 index 00000000..088d4da9 --- /dev/null +++ b/icons/jupyter/jupyter-plain-wordmark.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/icons/jupyter/jupyter-plain.svg b/icons/jupyter/jupyter-plain.svg new file mode 100644 index 00000000..b618168f --- /dev/null +++ b/icons/jupyter/jupyter-plain.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/icons/ocaml/ocaml-original-wordmark.svg b/icons/ocaml/ocaml-original-wordmark.svg new file mode 100644 index 00000000..657a9533 --- /dev/null +++ b/icons/ocaml/ocaml-original-wordmark.svg @@ -0,0 +1 @@ + diff --git a/icons/ocaml/ocaml-original.svg b/icons/ocaml/ocaml-original.svg new file mode 100644 index 00000000..927fd316 --- /dev/null +++ b/icons/ocaml/ocaml-original.svg @@ -0,0 +1 @@ + diff --git a/icons/ocaml/ocaml-plain-wordmark.svg b/icons/ocaml/ocaml-plain-wordmark.svg new file mode 100644 index 00000000..e91fe96c --- /dev/null +++ b/icons/ocaml/ocaml-plain-wordmark.svg @@ -0,0 +1 @@ + diff --git a/icons/ocaml/ocaml-plain.svg b/icons/ocaml/ocaml-plain.svg new file mode 100644 index 00000000..a575628d --- /dev/null +++ b/icons/ocaml/ocaml-plain.svg @@ -0,0 +1 @@ + diff --git a/package-lock.json b/package-lock.json index f995f26e..4945858d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "devicon", - "version": "2.2.0", + "version": "2.9.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index cdbe8970..6f1111da 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "devicon", - "version": "2.2.0", + "version": "2.9.0", "description": "Programming related icons collection", "main": "devicon.min.css", "scripts": { @@ -10,7 +10,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/konpa/devicon.git" + "url": "https://github.com/devicons/devicon.git" }, "keywords": [ "programming", @@ -18,12 +18,12 @@ "svg", "font" ], - "author": "konpa", + "author": "devicons", "license": "MIT", "bugs": { - "url": "https://github.com/konpa/devicon/issues" + "url": "https://github.com/devicons/devicon/issues" }, - "homepage": "http://konpa.github.io/devicon/", + "homepage": "https://devicon.dev", "devDependencies": { "gulp": "^4.0.0", "gulp-sass": "^4.1.0",