Skip to content

Commit aca4d8b

Browse files
authored
chore: add HTML tag to alpha package forward (#18032)
By tagging the `<span>` with a class, some JavaScript could detect the package reference at display time and turn it into a proper hyperlink. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent fd8e0e3 commit aca4d8b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

tools/@aws-cdk/pkglint/lib/readme-contents.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ export function cfnOnlyReadmeContents(options: LibraryReadmeOptions) {
6666
...(options.alphaPackageName ? [
6767
'',
6868
'> The construct library for this service is in preview. Since it is not stable yet, it is distributed',
69-
'> as a separate package so that you can pin its version independently of the rest of the CDK. See the package named:',
69+
'> as a separate package so that you can pin its version independently of the rest of the CDK. See the package:',
7070
'>',
71-
`> ${options.alphaPackageName}`,
71+
`> <span class="package-reference">${options.alphaPackageName}</span>`,
7272
] : []),
7373
'',
7474
'<!--BEGIN CFNONLY DISCLAIMER-->',

0 commit comments

Comments
 (0)