diff --git a/.changeset/techdocs-keep-it-on-the-download.md b/.changeset/techdocs-keep-it-on-the-download.md new file mode 100644 index 0000000000..20a6c4718f --- /dev/null +++ b/.changeset/techdocs-keep-it-on-the-download.md @@ -0,0 +1,7 @@ +--- +'@backstage/plugin-techdocs': patch +--- + +TechDocs now respects the `download` attribute on anchor tags in generated +markup, allowing documentation authors to bundle downloadable files with their +documentation. diff --git a/plugins/techdocs/src/reader/transformers/addBaseUrl.test.ts b/plugins/techdocs/src/reader/transformers/addBaseUrl.test.ts index 4311de5dae..afed2eff73 100644 --- a/plugins/techdocs/src/reader/transformers/addBaseUrl.test.ts +++ b/plugins/techdocs/src/reader/transformers/addBaseUrl.test.ts @@ -37,6 +37,7 @@ const fixture = ` + Download Now `; @@ -78,5 +79,11 @@ describe('addBaseUrl', () => { mockEntityId, '', ); + expect(techdocsStorageApi.getBaseUrl).toHaveBeenNthCalledWith( + 4, + 'afile.pdf', + mockEntityId, + '', + ); }); }); diff --git a/plugins/techdocs/src/reader/transformers/addBaseUrl.ts b/plugins/techdocs/src/reader/transformers/addBaseUrl.ts index 9cd11f0903..9bb5418bc2 100644 --- a/plugins/techdocs/src/reader/transformers/addBaseUrl.ts +++ b/plugins/techdocs/src/reader/transformers/addBaseUrl.ts @@ -48,6 +48,7 @@ export const addBaseUrl = ({ updateDom(dom.querySelectorAll('img'), 'src'); updateDom(dom.querySelectorAll('script'), 'src'); updateDom(dom.querySelectorAll('link'), 'href'); + updateDom(dom.querySelectorAll('a[download]'), 'href'); return dom; };