diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 2b06e911..5d0dd269 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -49,11 +49,7 @@ jobs: restore-keys: | ${{ runner.os }}-node- - name: Remove dark theme images from README - uses: mondeja/strip-gh-theme-links@v4 - with: - files: README.md - keep: light - strict: true + run: npm run strip-theme-link - name: Install dependencies run: npm i - name: Build NodeJS package @@ -78,11 +74,7 @@ jobs: export PACKAGE_VERSION=$(cat package.json | grep 'version' | sed 's/[ \",:]//g' | sed 's/version//') echo "::set-output name=version::$PACKAGE_VERSION" - name: Remove dark theme images from README - uses: mondeja/strip-gh-theme-links@v4 - with: - files: README.md - keep: light - strict: true + run: npm run strip-theme-link - name: Configure GIT credentials run: | git config user.name "${GITHUB_ACTOR}" diff --git a/README.md b/README.md index e42353e2..e37a9c83 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

-Simple Icons +Simple Icons

Simple Icons

Over 2500 Free SVG icons for popular brands. See them all on one page at SimpleIcons.org. Contributions, corrections & requests can be made on GitHub.

@@ -65,7 +65,7 @@ Where `[COLOR]` is optional, and can be replaced by the [hex colors](https://dev ``` -### Node Usage Node +### Node Usage Node The icons are also available through our npm package. To install, simply run: @@ -116,7 +116,7 @@ If you need to iterate over all icons, use: import * as icons from 'simple-icons'; ``` -#### TypeScript Usage Typescript +#### TypeScript Usage Typescript Type definitions are bundled with the package. @@ -124,7 +124,7 @@ Type definitions are bundled with the package. import type { SimpleIcon } from 'simple-icons'; ``` -### PHP Usage Php +### PHP Usage Php The icons are also available through our Packagist package. To install, simply run: @@ -150,30 +150,30 @@ echo file_get_contents('path/to/package/icons/simpleicons.svg'); | Extension | Author | | :-- | :-- | -| [Angular Module](https://github.com/avmaisak/ngx-simple-icons) Angular | [@avmaisak](https://github.com/avmaisak) | -| [Blazor Nuget](https://github.com/TimeWarpEngineering/timewarp-simple-icons) Blazor | [@TimeWarpEngineering](https://github.com/TimeWarpEngineering) | -| [Blender add-on](https://github.com/mondeja/simple-icons-blender) Blender | [@mondeja](https://github.com/mondeja) | -| [Drawio library](https://github.com/mondeja/simple-icons-drawio) Drawio | [@mondeja](https://github.com/mondeja) | -| [Drupal module](https://www.drupal.org/project/simple_icons) Drupal | [Phil Wolstenholme](https://www.drupal.org/u/phil-wolstenholme) | -| [Figma plugin](https://www.figma.com/community/plugin/1149614463603005908/Simple-Icons) Figma | [@LitoMore](https://github.com/LitoMore) | -| [Flutter package](https://pub.dev/packages/simple_icons) Flutter | [@jlnrrg](https://jlnrrg.github.io/) | -| [Framer component](https://github.com/LitoMore/simple-icons-framer) Framer | [@LitoMore](https://github.com/LitoMore) | -| [Hexo plugin](https://github.com/nidbCN/hexo-simpleIcons) Hexo | [@nidbCN](https://github.com/nidbCN/) | -| [Home Assistant plugin](https://github.com/vigonotion/hass-simpleicons) Home Assistant | [@vigonotion](https://github.com/vigonotion/) | -| [Hugo module](https://github.com/foo-dogsquared/hugo-mod-simple-icons) Hugo | [@foo-dogsquared](https://github.com/foo-dogsquared) | -| [Java library](https://github.com/silentsoft/simpleicons4j) OpenJDK | [@silentsoft](https://github.com/silentsoft) | -| [Jetpack Compose library](https://github.com/DevSrSouza/compose-icons) Jetpack Compose | [@devsrsouza](https://github.com/devsrsouza/) | -| [Kirby plugin](https://github.com/runxel/kirby3-simpleicons) Kirby | [@runxel](https://github.com/runxel) | -| [LaTeX package](https://github.com/ineshbose/simple-icons-latex) LaTeX | [@ineshbose](https://github.com/ineshbose) | -| [Laravel Package](https://github.com/ublabs/blade-simple-icons) Laravel | [@adrian-ub](https://github.com/adrian-ub) | -| [Python package](https://github.com/sachinraja/simple-icons-py) Python | [@sachinraja](https://github.com/sachinraja) | -| [React package](https://github.com/icons-pack/react-simple-icons) React | [@wootsbot](https://github.com/wootsbot) | -| [Solid package](https://github.com/x64Bits/solid-icons) Solid | [@x64Bits](https://github.com/x64Bits) | -| [Stream Deck icon pack](https://github.com/mackenly/simple-icons-stream-deck) Stream Deck | [@mackenly](https://github.com/mackenly) | -| [Svelte package](https://github.com/icons-pack/svelte-simple-icons) Svelte | [@wootsbot](https://github.com/wootsbot) | -| [Vue 3 package](https://github.com/wyatt-herkamp/vue3-simple-icons) Vue | [@wyatt-herkamp](https://github.com/wyatt-herkamp) | -| [Vue package](https://github.com/mainvest/vue-simple-icons) Vue | [@noahlitvin](https://github.com/noahlitvin) | -| [WordPress plugin](https://wordpress.org/plugins/simple-icons/) Wordpress | [@tjtaylo](https://github.com/tjtaylo) | +| [Angular Module](https://github.com/avmaisak/ngx-simple-icons) Angular | [@avmaisak](https://github.com/avmaisak) | +| [Blazor Nuget](https://github.com/TimeWarpEngineering/timewarp-simple-icons) Blazor | [@TimeWarpEngineering](https://github.com/TimeWarpEngineering) | +| [Blender add-on](https://github.com/mondeja/simple-icons-blender) Blender | [@mondeja](https://github.com/mondeja) | +| [Drawio library](https://github.com/mondeja/simple-icons-drawio) Drawio | [@mondeja](https://github.com/mondeja) | +| [Drupal module](https://www.drupal.org/project/simple_icons) Drupal | [Phil Wolstenholme](https://www.drupal.org/u/phil-wolstenholme) | +| [Figma plugin](https://www.figma.com/community/plugin/1149614463603005908/Simple-Icons) Figma | [@LitoMore](https://github.com/LitoMore) | +| [Flutter package](https://pub.dev/packages/simple_icons) Flutter | [@jlnrrg](https://jlnrrg.github.io/) | +| [Framer component](https://github.com/LitoMore/simple-icons-framer) Framer | [@LitoMore](https://github.com/LitoMore) | +| [Hexo plugin](https://github.com/nidbCN/hexo-simpleIcons) Hexo | [@nidbCN](https://github.com/nidbCN/) | +| [Home Assistant plugin](https://github.com/vigonotion/hass-simpleicons) Home Assistant | [@vigonotion](https://github.com/vigonotion/) | +| [Hugo module](https://github.com/foo-dogsquared/hugo-mod-simple-icons) Hugo | [@foo-dogsquared](https://github.com/foo-dogsquared) | +| [Java library](https://github.com/silentsoft/simpleicons4j) OpenJDK | [@silentsoft](https://github.com/silentsoft) | +| [Jetpack Compose library](https://github.com/DevSrSouza/compose-icons) Jetpack Compose | [@devsrsouza](https://github.com/devsrsouza/) | +| [Kirby plugin](https://github.com/runxel/kirby3-simpleicons) Kirby | [@runxel](https://github.com/runxel) | +| [LaTeX package](https://github.com/ineshbose/simple-icons-latex) LaTeX | [@ineshbose](https://github.com/ineshbose) | +| [Laravel Package](https://github.com/ublabs/blade-simple-icons) Laravel | [@adrian-ub](https://github.com/adrian-ub) | +| [Python package](https://github.com/sachinraja/simple-icons-py) Python | [@sachinraja](https://github.com/sachinraja) | +| [React package](https://github.com/icons-pack/react-simple-icons) React | [@wootsbot](https://github.com/wootsbot) | +| [Solid package](https://github.com/x64Bits/solid-icons) Solid | [@x64Bits](https://github.com/x64Bits) | +| [Stream Deck icon pack](https://github.com/mackenly/simple-icons-stream-deck) Stream Deck | [@mackenly](https://github.com/mackenly) | +| [Svelte package](https://github.com/icons-pack/svelte-simple-icons) Svelte | [@wootsbot](https://github.com/wootsbot) | +| [Vue 3 package](https://github.com/wyatt-herkamp/vue3-simple-icons) Vue | [@wyatt-herkamp](https://github.com/wyatt-herkamp) | +| [Vue package](https://github.com/mainvest/vue-simple-icons) Vue | [@noahlitvin](https://github.com/noahlitvin) | +| [WordPress plugin](https://wordpress.org/plugins/simple-icons/) Wordpress | [@tjtaylo](https://github.com/tjtaylo) | ## Contribute diff --git a/assets/readme/angular-white.svg b/assets/readme/angular-white.svg deleted file mode 100644 index 7844c277..00000000 --- a/assets/readme/angular-white.svg +++ /dev/null @@ -1 +0,0 @@ -Angular \ No newline at end of file diff --git a/assets/readme/blazor-white.svg b/assets/readme/blazor-white.svg deleted file mode 100644 index e1d1208a..00000000 --- a/assets/readme/blazor-white.svg +++ /dev/null @@ -1 +0,0 @@ -Blazor \ No newline at end of file diff --git a/assets/readme/blender-white.svg b/assets/readme/blender-white.svg deleted file mode 100644 index bb4810a0..00000000 --- a/assets/readme/blender-white.svg +++ /dev/null @@ -1 +0,0 @@ -Blender \ No newline at end of file diff --git a/assets/readme/diagramsdotnet-white.svg b/assets/readme/diagramsdotnet-white.svg deleted file mode 100644 index d0fd5081..00000000 --- a/assets/readme/diagramsdotnet-white.svg +++ /dev/null @@ -1 +0,0 @@ -diagrams.net \ No newline at end of file diff --git a/assets/readme/drupal-white.svg b/assets/readme/drupal-white.svg deleted file mode 100644 index d53a9986..00000000 --- a/assets/readme/drupal-white.svg +++ /dev/null @@ -1 +0,0 @@ -Drupal \ No newline at end of file diff --git a/assets/readme/elgato-white.svg b/assets/readme/elgato-white.svg deleted file mode 100644 index f51f2eb9..00000000 --- a/assets/readme/elgato-white.svg +++ /dev/null @@ -1 +0,0 @@ -Elgato \ No newline at end of file diff --git a/assets/readme/figma-white.svg b/assets/readme/figma-white.svg deleted file mode 100644 index 3bdd1909..00000000 --- a/assets/readme/figma-white.svg +++ /dev/null @@ -1 +0,0 @@ -Figma \ No newline at end of file diff --git a/assets/readme/flutter-white.svg b/assets/readme/flutter-white.svg deleted file mode 100644 index 3fd3bfb2..00000000 --- a/assets/readme/flutter-white.svg +++ /dev/null @@ -1 +0,0 @@ -Flutter \ No newline at end of file diff --git a/assets/readme/framer-white.svg b/assets/readme/framer-white.svg deleted file mode 100644 index 87402402..00000000 --- a/assets/readme/framer-white.svg +++ /dev/null @@ -1 +0,0 @@ -Framer \ No newline at end of file diff --git a/assets/readme/hexo-white.svg b/assets/readme/hexo-white.svg deleted file mode 100644 index ecbcdff1..00000000 --- a/assets/readme/hexo-white.svg +++ /dev/null @@ -1 +0,0 @@ -Hexo \ No newline at end of file diff --git a/assets/readme/homeassistant-white.svg b/assets/readme/homeassistant-white.svg deleted file mode 100644 index ec9813d5..00000000 --- a/assets/readme/homeassistant-white.svg +++ /dev/null @@ -1 +0,0 @@ -Home Assistant \ No newline at end of file diff --git a/assets/readme/hugo-white.svg b/assets/readme/hugo-white.svg deleted file mode 100644 index 18e5a187..00000000 --- a/assets/readme/hugo-white.svg +++ /dev/null @@ -1 +0,0 @@ -Hugo \ No newline at end of file diff --git a/assets/readme/jetpackcompose-white.svg b/assets/readme/jetpackcompose-white.svg deleted file mode 100644 index 80252ac0..00000000 --- a/assets/readme/jetpackcompose-white.svg +++ /dev/null @@ -1 +0,0 @@ -Jetpack Compose \ No newline at end of file diff --git a/assets/readme/kirby-white.svg b/assets/readme/kirby-white.svg deleted file mode 100644 index 79958843..00000000 --- a/assets/readme/kirby-white.svg +++ /dev/null @@ -1 +0,0 @@ -Kirby \ No newline at end of file diff --git a/assets/readme/laravel-white.svg b/assets/readme/laravel-white.svg deleted file mode 100644 index 3edfcea5..00000000 --- a/assets/readme/laravel-white.svg +++ /dev/null @@ -1 +0,0 @@ -Laravel \ No newline at end of file diff --git a/assets/readme/latex-white.svg b/assets/readme/latex-white.svg deleted file mode 100644 index 87e4bb70..00000000 --- a/assets/readme/latex-white.svg +++ /dev/null @@ -1 +0,0 @@ -LaTeX \ No newline at end of file diff --git a/assets/readme/nodedotjs-white.svg b/assets/readme/nodedotjs-white.svg deleted file mode 100644 index ed8a6959..00000000 --- a/assets/readme/nodedotjs-white.svg +++ /dev/null @@ -1 +0,0 @@ -Node.js \ No newline at end of file diff --git a/assets/readme/openjdk-white.svg b/assets/readme/openjdk-white.svg deleted file mode 100644 index 95379645..00000000 --- a/assets/readme/openjdk-white.svg +++ /dev/null @@ -1 +0,0 @@ -OpenJDK \ No newline at end of file diff --git a/assets/readme/php-white.svg b/assets/readme/php-white.svg deleted file mode 100644 index f20b708b..00000000 --- a/assets/readme/php-white.svg +++ /dev/null @@ -1 +0,0 @@ -PHP \ No newline at end of file diff --git a/assets/readme/python-white.svg b/assets/readme/python-white.svg deleted file mode 100644 index 452d9b7e..00000000 --- a/assets/readme/python-white.svg +++ /dev/null @@ -1 +0,0 @@ -Python \ No newline at end of file diff --git a/assets/readme/react-white.svg b/assets/readme/react-white.svg deleted file mode 100644 index a1197a26..00000000 --- a/assets/readme/react-white.svg +++ /dev/null @@ -1 +0,0 @@ -React \ No newline at end of file diff --git a/assets/readme/simpleicons-white.svg b/assets/readme/simpleicons-white.svg deleted file mode 100644 index 21bd6b51..00000000 --- a/assets/readme/simpleicons-white.svg +++ /dev/null @@ -1 +0,0 @@ -Simple Icons \ No newline at end of file diff --git a/assets/readme/solid-white.svg b/assets/readme/solid-white.svg deleted file mode 100644 index 438f64e0..00000000 --- a/assets/readme/solid-white.svg +++ /dev/null @@ -1 +0,0 @@ -Solid \ No newline at end of file diff --git a/assets/readme/svelte-white.svg b/assets/readme/svelte-white.svg deleted file mode 100644 index 4a04412d..00000000 --- a/assets/readme/svelte-white.svg +++ /dev/null @@ -1 +0,0 @@ -Svelte \ No newline at end of file diff --git a/assets/readme/typescript-white.svg b/assets/readme/typescript-white.svg deleted file mode 100644 index 968ff97e..00000000 --- a/assets/readme/typescript-white.svg +++ /dev/null @@ -1 +0,0 @@ -TypeScript \ No newline at end of file diff --git a/assets/readme/vuedotjs-white.svg b/assets/readme/vuedotjs-white.svg deleted file mode 100644 index 1c9e2bee..00000000 --- a/assets/readme/vuedotjs-white.svg +++ /dev/null @@ -1 +0,0 @@ -Vue.js \ No newline at end of file diff --git a/assets/readme/wordpress-white.svg b/assets/readme/wordpress-white.svg deleted file mode 100644 index 25ed7792..00000000 --- a/assets/readme/wordpress-white.svg +++ /dev/null @@ -1 +0,0 @@ -WordPress \ No newline at end of file diff --git a/package.json b/package.json index 2f35ba1a..278efded 100644 --- a/package.json +++ b/package.json @@ -97,7 +97,8 @@ "pretest": "npm run prepublishOnly", "posttest": "npm run postpublish", "get-filename": "node scripts/get-filename.js", - "add-icon-data": "node scripts/add-icon-data.js" + "add-icon-data": "node scripts/add-icon-data.js", + "strip-theme-link": "node scripts/build/strip-theme-link.js" }, "engines": { "node": ">=0.12.18" diff --git a/scripts/build/strip-theme-link.js b/scripts/build/strip-theme-link.js new file mode 100644 index 00000000..cc8ab7ef --- /dev/null +++ b/scripts/build/strip-theme-link.js @@ -0,0 +1,22 @@ +/** + * @fileoverview + * Simple Icons strip theme URL script. + */ + +import path from 'node:path'; +import { writeFile, readFile } from 'node:fs/promises'; +import { getDirnameFromImportMeta } from '../../sdk.mjs'; + +const __dirname = getDirnameFromImportMeta(import.meta.url); + +const rootDir = path.resolve(__dirname, '..', '..'); +const readmeFile = path.resolve(rootDir, 'README.md'); + +const readme = await readFile(readmeFile, 'utf8'); +await writeFile( + readmeFile, + readme.replace( + /https:\/\/cdn.simpleicons.org\/(.+)\/000\/fff/g, + 'https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/$1.svg', + ), +); diff --git a/sdk.mjs b/sdk.mjs index b3851fde..889de7b1 100644 --- a/sdk.mjs +++ b/sdk.mjs @@ -196,9 +196,7 @@ export const getThirdPartyExtensions = async ( let [module, author] = line.split(' | '); // README shipped with package has not Github theme image links - module = module.split( - module.includes('') ? '' : ' { - const blackIconsPath = path.join(root, 'icons'); - const whiteIconsPath = path.join(root, 'assets', 'readme'); - const whiteIconsFileNames = fs.readdirSync(whiteIconsPath); - - for (let whiteIconFileName of whiteIconsFileNames) { - const whiteIconPath = path.join(whiteIconsPath, whiteIconFileName); - const blackIconPath = path.join( - blackIconsPath, - whiteIconFileName.replace(/-white\.svg$/, '.svg'), - ); - const whiteIconRelPath = path.relative(root, whiteIconPath); - const blackIconRelPath = path.relative(root, blackIconPath); - - test(`'${whiteIconRelPath}' content must be equivalent to '${blackIconRelPath}' content`, () => { - assert.ok( - whiteIconFileName.endsWith('-white.svg'), - `README icon assets file name '${whiteIconFileName}'` + - " must ends with '-white.svg'.", - ); - - assert.ok( - fs.existsSync(blackIconPath), - `Corresponding icon '${blackIconRelPath}' for README asset '${whiteIconRelPath}'` + - ` not found in '${path.dirname(blackIconRelPath)}' directory.`, - ); - - const whiteIconContent = fs.readFileSync(whiteIconPath, 'utf8'); - const blackIconContent = fs.readFileSync(blackIconPath, 'utf8'); - assert.equal( - whiteIconContent, - blackIconContent.replace(' { const readmePath = path.join(root, 'README.md'); const thirdPartyExtensions = await getThirdPartyExtensions(readmePath);