paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 26 Packages Projects Releases Wiki Activity

Add examples for creating download links

Browse Source 
Fixes #17734

Relates #13940 #6069

Signed-off-by: Wedge Jarrad <wedge.jarrad@gmail.com>
This commit is contained in:
Wedge Jarrad
2024-06-05 18:21:53 -07:00
parent 9d9abd073b
commit 1c3e1a88ec
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/how-to-guides.md
+20
View File
@@ -874,3 +874,23 @@ metadata:
TechDocs supports using the [mkdocs-redirects](https://github.com/mkdocs/mkdocs-redirects/tree/master) plugin to create a redirect map for any TechDocs site. This allows broken links from renamed or moved pages in your site to be redirected to their specified replacement.
TechDocs will notify the user that the page they are trying to access is no longer maintained. Then, they will be redirected. External site redirects are not supported. If an external redirect is provided, the user will instead be redirected to the index page of the documentation site.
## Create download links for static assets
You may want to make files available for download by your users such as PDF
documents, images, or code templates. Download links for files included in your
docs directory can be made by adding `{: download }` after a markdown link.
```
[Link text](./img/foo.jpg){: download }
```
The user's browser will download the file as `download.jpg` when the link is
clicked.
Specify a file name to control the name the file will be given when it is
downloaded:
```
[Link text](./img/foo.jpg){: download="foo.jpg" }
```