Mibew/simple-icons
1
0
Fork 0
mirror of https://github.com/Mibew/simple-icons.git synced 2025-10-31 18:41:07 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update ReadMe to use GitHub formatting (#9928)

Browse Source 
* Add GH README tags, and update link stripping theme to include.

* Remove bold text

* Remove additional detail

* Re-add bold text to non GH titles

* Update README.md

* Fix Notice Formatting
This commit is contained in:
Adam Rusted 2023-11-28 17:48:10 +00:00 committed by GitHub
parent fb3ed948a8
commit 5b19bae8a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -17,7 +17,7 @@ Over 2700 Free SVG icons for popular brands. See them all on one page at <a href
## Usage ## Usage
> **Note**\ > [!NOTE]\
> We ask that all users read our [legal disclaimer](https://github.com/simple-icons/simple-icons/blob/develop/DISCLAIMER.md) before using icons from Simple Icons. > We ask that all users read our [legal disclaimer](https://github.com/simple-icons/simple-icons/blob/develop/DISCLAIMER.md) before using icons from Simple Icons.
### General Usage ### General Usage
@ -179,7 +179,7 @@ echo file_get_contents('path/to/package/icons/simpleicons.svg');
| [Vue package](https://github.com/mainvest/vue-simple-icons) <img src="https://cdn.simpleicons.org/vuedotjs/000/fff" alt="Vue" align=left width=24 height=24> | [@noahlitvin](https://github.com/noahlitvin) | ![](https://img.shields.io/github/license/mainvest/vue-simple-icons) | ![](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmainvest%2Fvue-simple-icons%2Fmaster%2Fpackage.json&query=%24.version&logo=simpleicons&label=version) | | [Vue package](https://github.com/mainvest/vue-simple-icons) <img src="https://cdn.simpleicons.org/vuedotjs/000/fff" alt="Vue" align=left width=24 height=24> | [@noahlitvin](https://github.com/noahlitvin) | ![](https://img.shields.io/github/license/mainvest/vue-simple-icons) | ![](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmainvest%2Fvue-simple-icons%2Fmaster%2Fpackage.json&query=%24.version&logo=simpleicons&label=version) |
| [WordPress plugin](https://wordpress.org/plugins/simple-icons/) <img src="https://cdn.simpleicons.org/wordpress/000/fff" alt="WordPress" align=left width=24 height=24> | [@tjtaylo](https://github.com/tjtaylo) | ![](https://img.shields.io/badge/license-GPL_v2-blue.svg) | [![v4.25.0](https://img.shields.io/static/v1?label=version&message=v4.25.0&logo=simpleicons&color=red)](https://github.com/simple-icons/simple-icons/tree/4.25.0) | | [WordPress plugin](https://wordpress.org/plugins/simple-icons/) <img src="https://cdn.simpleicons.org/wordpress/000/fff" alt="WordPress" align=left width=24 height=24> | [@tjtaylo](https://github.com/tjtaylo) | ![](https://img.shields.io/badge/license-GPL_v2-blue.svg) | [![v4.25.0](https://img.shields.io/static/v1?label=version&message=v4.25.0&logo=simpleicons&color=red)](https://github.com/simple-icons/simple-icons/tree/4.25.0) |
> **Note for Extension Authors**\ > [!IMPORTANT]\
> From our next major release (v11, releasing on May 26, 2024), we will begin removing third-party extensions from the above list that are not up to date with at least our previous major release.\ > From our next major release (v11, releasing on May 26, 2024), we will begin removing third-party extensions from the above list that are not up to date with at least our previous major release.\
> For example, when v11 is released, we will remove any extensions that don't support `v10.0.0` or higher.\ > For example, when v11 is released, we will remove any extensions that don't support `v10.0.0` or higher.\
> Please create a PR to update the version number of your extension in this README following each update of your extension. > Please create a PR to update the version number of your extension in this README following each update of your extension.

11
scripts/release/reformat-readme.js
View File

@ -17,8 +17,17 @@ const readmeFile = path.resolve(rootDir, 'README.md');
const readme = await readFile(readmeFile, 'utf8'); const readme = await readFile(readmeFile, 'utf8');
await writeFile( await writeFile(
readmeFile, readmeFile,
readme.replace( readme
.replace(
/https:\/\/cdn.simpleicons.org\/(.+)\/000\/fff/g, /https:\/\/cdn.simpleicons.org\/(.+)\/000\/fff/g,
`https://raw.githubusercontent.com/simple-icons/simple-icons/${LINKS_BRANCH}/icons/$1.svg`, `https://raw.githubusercontent.com/simple-icons/simple-icons/${LINKS_BRANCH}/icons/$1.svg`,
)
.replace(
/\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\](?!\()/g,
function (str, $0) {
const capital = $0.substr(0, 1);
const body = $0.substr(1).toLowerCase();
return `**${capital + body}**`;
},
), ),
); );