Custom Components
Some components cannot be supported by Markdown syntax, and have to be customized, including
Google Presentation
Sample code
{{< google-slides url="https://docs.google.com/presentation/d/1UfPh-_jrA05fs13KiU5sYQufp_ffhOVfSOm-Ox8vO40/preview?slide=id.g28d600eef7c_0_5" >}}
Would be displayed as
How to use:
- Copy the sample code above to the page you are working on
- Replace the URL with correct URL of your Google Presentation
Notes:
- Ensure you don’t remove the quotation marks.
- Ensure your URL is at 1st slide of the presentation.
Downloadable files
Applied for PDF, CSV, Excel or any file that is not images or videos.
Sample for downloading file /static/download-content/sample-file.csv
{{< download href="/download-content/sample-file.csv" >}}
Title of the download link here
{{< /download >}}
Would be displayed as
Title of the download link hereHow to use
- Copy the sample code above to the page you are working on
- Put the file in folder /static/download-content/
- Replace the file name with your file to download
Video
Avoid adding large video file to this Gitlab repository
Contact IT team if you need to add large video file (> 50 MB) to the wiki. This repository is mainly for maintaining light-weight documentation. It is not suitable for storing large files in general
{{< video url="https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm" >}}
Would be displayed as
How to use
- Contact IT team to handle uploading video to wiki. The IT team would return back an URL of the video
- Copy the sample code above to the page you are working on
- Replace the URL with your video’s URL
Callouts
Source article: https://getdoks.org/docs/guides/shortcodes/#callouts
How to use
- Copy code of the callout you want to use below to your file
- Edit the title “Enter title here or leave blank” or remove the whole title.
- Edit the text inside “Content of callout. Use normal Markdown syntax” to your preference
Syntax
- Note (Blue color)
{{< callout context="note" icon="info-circle-filled" title="Enter title here or leave blank" >}}
Content of callout. Use normal Markdown syntax
{{< /callout >}}
Enter title here or leave blank
Content of callout. Use normal Markdown syntax
- Tip (Purple color)
{{< callout context="tip" icon="star-filled" title="Enter title here or leave blank" >}}
Content of callout. Use normal Markdown syntax
{{< /callout >}}
Enter title here or leave blank
Content of callout. Use normal Markdown syntax
- Success (Yellow color)
{{< callout context="success" icon="circle-check-filled" title="Enter title here or leave blank" >}}
Content of callout. Use normal Markdown syntax
{{< /callout >}}
Enter title here or leave blank
Content of callout. Use normal Markdown syntax
- Warning (Yellow color)
{{< callout context="caution" icon="alert-triangle-filled" title="Enter title here or leave blank" >}}
Content of callout. Use normal Markdown syntax
{{< /callout >}}
Enter title here or leave blank
Content of callout. Use normal Markdown syntax
- Danger (Red color)
{{< callout context="danger" icon="alert-triangle-filled" title="Enter title here or leave blank" >}}
Content of callout. Use normal Markdown syntax
{{< /callout >}}
Enter title here or leave blank
Content of callout. Use normal Markdown syntax