Markdown
In addition to the standard gfm syntax, Doom has some built-in extended Markdown features.
TOC
Callouts
Source code annotation component
NOTE
- Please use inline code comments according to the actual language, such as
;
, %
, #
, //
, /** */
, --
, and <!-- -->
.
- If you need to treat it as a code comment, use
[\!code callout]
for escaping.
- Sometimes,
:::callouts
may display incorrectly due to nested indentation; you can use <div class="doom-callouts">
or <Callouts>
component instead.
```sh
Memory overhead per virtual machine ≈ (1.002 × requested memory) \
+ 218 MiB \
+ 8 MiB × (number of vCPUs) \
+ 16 MiB × (number of graphics devices) \
+ (additional memory overhead)
```
:::callouts
1. Required for the processes that run in the `virt-launcher` pod.
2. Number of virtual CPUs requested by the virtual machine.
3. Number of virtual graphics cards requested by the virtual machine.
4. Additional memory overhead:
- If your environment includes a Single Root I/O Virtualization (SR-IOV) network device or a Graphics Processing Unit (GPU), allocate 1 GiB additional memory overhead for each device.
- If Secure Encrypted Virtualization (SEV) is enabled, add 256 MiB.
- If Trusted Platform Module (TPM) is enabled, add 53 MiB.
:::
Memory overhead per virtual machine ≈ (1.002 × requested memory) \
+ 218 MiB \
+ 8 MiB × (number of vCPUs) \
+ 16 MiB × (number of graphics devices) \
+ (additional memory overhead)
- Required for the processes that run in the
virt-launcher
pod.
- Number of virtual CPUs requested by the virtual machine.
- Number of virtual graphics cards requested by the virtual machine.
- Additional memory overhead:
- If your environment includes a Single Root I/O Virtualization (SR-IOV) network device or a Graphics Processing Unit (GPU), allocate 1 GiB additional memory overhead for each device.
- If Secure Encrypted Virtualization (SEV) is enabled, add 256 MiB.
- If Trusted Platform Module (TPM) is enabled, add 53 MiB.
For more source code conversion features, please refer to Shiki Transformers.
Chart drawing tool
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
Combined with Markdown Preview Mermaid, you can preview in real-time within VSCode.