Document idSuffix

badges · Oct 8, 2024 · 4652646 · 4652646
1 parent 84de38f
commit 4652646
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/badge-maker/README.md b/badge-maker/README.md
@@ -73,6 +73,10 @@ The format is the following:
   // (Optional) One of: 'plastic', 'flat', 'flat-square', 'for-the-badge' or 'social'
   // Each offers a different visual design.
   style: 'flat',
+
+  // (Optional) A string with only letters, numbers, -, and _. This can be used to prevent
+  // CSS cross-contamination when the SVG badge is embedded directly into HTML pages.
+  idSuffix: 'dd'
 }
 ```