From 09d690d15cb6daf060eb143804063a12c668f6e8 Mon Sep 17 00:00:00 2001 From: canaleal Date: Mon, 16 Nov 2026 06:54:03 -0500 Subject: [PATCH] Updated readme --- README.md | 437 +++++++++++++++++++++++++++++------------------------- 1 file changed, 233 insertions(+), 204 deletions(-) diff --git a/README.md b/README.md index 8ffb181e1..1db091941 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ -

- +

+ + Devicon Logo + +

Devicon

+

+ A curated collection of logos for programming languages, frameworks, and development tools.
+ Available as a font, as raw SVGs, or via CDN. +

+

+ Website + · + Request an Icon + · + Contribute + · + Discord +

+ + GitHub release (latest by semver) @@ -26,294 +44,305 @@ Devicons npm downloads/month -

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

- Demo - · - Request Icon - · - Contribute -

-

TL;DR

+
+ +## Table of Contents + +- [About](#about) +- [Quick Start](#quick-start) +- [Usage](#usage) + - [Font (recommended)](#font-recommended) + - [Inline SVG](#inline-svg) + - [Image tag](#image-tag) + - [CDN](#cdn) +- [Requesting an Icon](#requesting-an-icon) +- [Contributing](#contributing) +- [Community](#community) +- [Branches](#branches) +- [Stale Pull Requests](#stale-pull-requests) +- [Tools](#tools) +- [Building Devicon](#building-devicon) +- [Acknowledgements](#acknowledgements) +- [Disclaimer](#disclaimer) + +## About + +Devicon gathers the logos of development languages and tools in one place. Every icon comes in several variants: + +| Variant | Options | +| --- | --- | +| Format | Font or SVG | +| Style | `original`, `plain`, `line` | +| Color | Colored or monochrome | +| Wordmark | With or without | + +Devicon has 600+ icons, and it's growing. See [`devicon.json`](/devicon.json) or [devicon.dev](https://devicon.dev) for the complete, up-to-date list. +

+ Thanks to all our contributors and the IcoMoon app. Devicon would not be possible without you. +

+ +## Quick Start ```html - + - + ``` -

Table of Contents

-
    -
  1. About the Project
  2. -
  3. Getting Started
  4. -
  5. Requesting Icon
  6. -
  7. Contributing
  8. -
  9. Discord Community
  10. -
  11. develop vs master
  12. -
  13. Stale Pull Requests
  14. -
  15. Building Devicon
  16. -
- -

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. -

+## Usage -

- Thanks to all our contributors and the IcoMoon app. Devicon would not be possible without you. -

+For the fastest setup, head to [devicon.dev](https://devicon.dev). Otherwise, pick whichever method suits your project. - - 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. Usage of these logos should be done according to the company/brand/service's brand policy. - +### Font (recommended) -

Getting Started

-

- For a super fast setup, go check devicon.dev.
- You can either use the raw SVG icons, our Devicon font (which is - also available via CDN), or by building Devicon yourself. -

- -

Use the devicon font (recommended)

-

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

+Install Devicon with your package manager: ```bash npm install --save devicon +# or yarn add devicon ``` -

- 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: -

+No package manager? Download [`devicon.min.css`](/devicon.min.css) and place it next to the [`fonts`](/fonts) folder in your project. + +Include the stylesheet in your header: ```html ``` -

Start using icons with <i>-tag:

+Then use icons with the `` tag: ```html - + - + - + - + ``` -

- An alternate way to use devicon is by copy/pasting the raw SVG code - to your project. -

-

Copy/paste SVG code (from the SVG folder or the project page):

+### Inline SVG + +Copy the SVG code from the [`icons`](https://github.com/devicons/devicon/tree/master/icons) folder or from [devicon.dev](https://devicon.dev) and paste it into your markup: ```html - - + ``` -Add the following CSS rules in your stylesheet: +Style it with CSS: ```css .devicon-devicon-plain { max-width: 2em; } -/* if you want to change the original color */ +/* change the original color */ .devicon-devicon-plain path { fill: #4691f6; } ``` -

You can also use the img tag and reference an SVG directly from the repository:

+### Image tag + +Reference an SVG straight from the repository: ```html - +Devicon ``` -

Requesting an icon

-

- When you want to request an icon please feel free to create an issue. Check out our Wiki for more information. -

- -

Contributing

-

- We are happy with every contribution, whether it's new icons, features, or maintainers. Please have a look at our Wiki to see how you can contribute to this project. -

- -

Discord community

-

-We have a Discord community for Devicons. You can easily request icons, discuss, and have a good time talking with the community members! Join the official Discord Server here! -

- -

develop vs master

-

-All official releases shall be in master. Any updates in between (icons, features, etc.) will be kept in develop. -

-develop contains: -
    -
  • - Latest SVGs (non-optimized). -
  • -
  • - No icons for the latest SVGs. These will be built at every release.
    - Can be built manually. See Building Devicon. -
  • -
  • - Experimental changes. -
  • -
-master contains: -
    -
  • - Latest official release, which contains all the SVGs and icons. -
  • -
  • - Official, tested changes. -
  • -
- -

Stale Pull Requests

-

-After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited. -

- -

Building Devicon

-

-Follow these steps to build the website and icons either locally or using Gitpod.io. -

- -

Table of contents

-
    -
  1. Using Gitpod to build
  2. -
  3. Local Installation
  4. -
      -
    1. Install dependencies
    2. -
    3. Build the icons
    4. -
    5. Build the CSS stylesheet
    6. -
    7. Setting up the web server
    8. -
    -
- -

Using Gitpod.io

-

By using Gitpod.io, you can easily build the icons and install the
required dependencies in one single click. No extra setup is required.

- -Open in Gitpod - -> **Note** -> In case some of the commands are not properly ran, you can\ -> follow the steps below and run the same commands on Gitpod.io - -

Local Installation

- -

Install dependencies

- -

Fork the repository and clone the forked repository.

+### CDN + +Devicon is served through [jsDelivr](https://www.jsdelivr.com/package/npm/devicon). See [devicon.dev](https://devicon.dev) for details on adding it to your project via CDN. + +## Requesting an Icon + +Missing a logo? [Open an icon request](https://github.com/devicons/devicon/issues/new?assignees=&labels=request%3Aicon&template=icon-request.md&title=Icon+request%3A+%5BNAME%5D). The [wiki](https://github.com/devicons/devicon/wiki/Requesting-an-Icon) has more information on what makes a good request. + +## Contributing + +Every contribution is welcome, whether it's new icons, features, or maintainers. The [wiki](https://github.com/devicons/devicon/wiki) explains how to get started. + +## Community + +Join the [official Discord server](https://discord.gg/hScy8KWACQ) to request icons, ask questions, and chat with other contributors. + +## Branches + +All official releases live on `master`. Everything in between (icons, features, experiments) is kept on `develop`. + +| Branch | Contains | +| --- | --- | +| `master` | The latest official release with all SVGs and built icons. Official, tested changes only. | +| `develop` | The latest non-optimized SVGs, with no built icons for them (these are built at each release, or manually, see [Building Devicon](#building-devicon)). Experimental changes. | + +## Stale Pull Requests + +A pull request with no activity or response from the author for over 30 days is automatically marked as stale. We may fork your changes and merge them ourselves. Because GitHub tracks contributions by commit, you will still be credited. + +## Tools + +These are the tools and services we use to build, maintain, and distribute Devicon. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ToolUsed for
GitGitVersion control
GitHubGitHubHosting, issues, pull requests, and releases
GitHub ActionsGitHub ActionsAutomated checks, icon validation, and release workflows
Node.jsNode.js & npmBuild scripts, dependencies, and publishing the devicon package
PythonPythonAutomation scripts and the local development server
SeleniumSeleniumBrowser automation to generate the icon font
FirefoxFirefoxBrowser used by Selenium during the icon build
🎨IcoMoonConverting SVGs into the Devicon icon font
GitpodGitpodOne-click, preconfigured development environment
📦jsDelivrCDN delivery of the stylesheet, fonts, and SVGs
DiscordDiscordCommunity support and icon requests
+ +## Building Devicon + +Build the icons and website locally, or use Gitpod to skip the setup. + +### Using Gitpod + +[Gitpod](https://www.gitpod.io) installs the required dependencies and builds the icons in one click. No extra setup is needed. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/devicons/devicon/tree/develop) + +> [!NOTE] +> If a command doesn't run properly on Gitpod, follow the local steps below and run them in the Gitpod terminal. + +### Local installation + +#### 1. Prerequisites + +| Requirement | Notes | +| --- | --- | +| [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) | Needed to clone the repository | +| [Node.js and npm](https://kinsta.com/blog/how-to-install-node-js/) | Required to build Devicon | +| [Firefox](https://www.mozilla.org/en-US/firefox/new/) | Used for the icon build | +| [Python 3.8](https://www.python.org/downloads/) | Make sure your install includes [pip](https://pypi.org/project/pip/) | + +#### 2. Clone and install dependencies + +[Fork](https://github.com/devicons/devicon/fork) the repository, then clone your fork: ```bash git clone https://github.com//devicon.git +cd devicon ``` -> **Note** -> In case you don't have Git installed, check the official guide to install Git on your operating system. - -

Install all the necessary NPM dependencies

+Install the Node and Python dependencies: ```bash npm install -``` - -> **Note** -> In case you don't have NPM installed, check this ultimate guide on installing Node.js and NPM. These tools are required in order to build Devicon properly. - -

Install Firefox

-https://www.mozilla.org/en-US/firefox/new/ - -

Install Python 3.8

-https://www.python.org/downloads/ - -> **Note** -> Make sure your Python install includes [pip](https://pypi.org/project/pip/) - -

Install Dependencies

- -```bash python -m pip install -r ./.github/scripts/requirements.txt ``` -

Build the new icons

+#### 3. Build the icons -

Once all the dependencies are installed, you can proceed to build the newest icons.
-Usually, this is done on each release, but you can have a sneak peek before a release.

+Icons are normally built on each release, but you can build the latest ones yourself for a sneak peek: ```bash npm run build-icons ``` -The process might take a while, depending on your operating system's speed and the amount of icons. -

If there are any errors shown, please let us know by creating an issue or contacting us on our Discord community.

+> [!NOTE] +> This can take a while, depending on your system and the number of icons. If you hit errors, please [create an issue](https://github.com/devicons/devicon/issues/new/choose) or reach out on [Discord](https://discord.gg/hScy8KWACQ). -

Build the CSS stylesheet

+#### 4. Build the CSS stylesheet -

Run the following command to build the new CSS stylesheet.
-This file is used to show all the new icons previously built.

+This generates the stylesheet that displays the newly built icons: ```bash npm run build-css ``` -

Setting up the web server

- -

Run the following command to start the web server with Python.

+#### 5. Start the web server ```bash -npm run dev # Will run on port 8000 +npm run dev # runs on port 8000 ``` -

Or this command, which does exactly the same, but the port can be customized.

+Or choose your own port: ```bash python -m http.server ``` -

You're done now! :tada: Your build of Devicons should be available at https://localhost:8000 (or the desired port).

+Done! 🎉 Your build is now available at `http://localhost:8000` (or your chosen port). + +## Acknowledgements -
+Thanks to all of our [contributors](https://github.com/devicons/devicon/graphs/contributors) and to the [IcoMoon app](https://icomoon.io/#home). Devicon would not be possible without you. + +## Disclaimer + +All product names, logos, and brands are property of their respective owners. All company, product, and service names used in this project are for identification purposes only. Use of these names, logos, and brands does not imply endorsement. Please use these logos in accordance with each company, brand, or service's brand policy. + +
- - + Built with love + Built by developers