Skip to content

Commit 739d6ab

Browse files
committed
Update blog post with badge description, add/update images
1 parent e72f89f commit 739d6ab

File tree

5 files changed

+7
-4
lines changed

5 files changed

+7
-4
lines changed
17.1 KB
Loading
17.3 KB
Loading
187 KB
Loading
69.6 KB
Loading

Resources/Blog/Posts/introducing-custom-package-collections.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,19 @@ The `key` field essentially determines the URL at which the package collection i
2525

2626
The `name` is its display name on the collections page as well as on the package page where we show a package’s membership to package collections:
2727

28-
TODO: update image with new badge icon
29-
3028
<picture>
31-
<source srcset="/images/blog/custom-collections-package-page.png" media="(prefers-color-scheme: dark)">
29+
<source srcset="/images/blog/custom-collections-package-page-dark.png" media="(prefers-color-scheme: dark)">
3230
<img src="/images/blog/custom-collections-package-page-light.png" alt="Screenshot of the custom collection badge on a package page.">
3331
</picture>
3432

3533
The `description` field brielfly explains the motivation for this custom collection. It serves informational purposes and is not displayed.
3634

37-
TODO: describe `badge` attribute.
35+
The optional field `badge` can be used to style the representation of the collection on the package page. If present, it will be set apart with a different background as shown in the screenshot below.
36+
37+
<picture>
38+
<source srcset="/images/blog/custom-collection-badge-dark.png" media="(prefers-color-scheme: dark)">
39+
<img src="/images/blog/custom-collection-badge-light.png" alt="Screenshot of the custom collection display with and without badge.">
40+
</picture>
3841

3942
Finally, the `url` field points to a location where you maintain a list of package URLs that belong to the collection. There should be of the format `https://github.com/author/package.git`. In particular, make sure the URL scheme is `https` and the `.git` suffix is included.
4043

0 commit comments

Comments
 (0)