logo
Doom
English
简体中文
English
简体中文
logo
Doom
Introduction
Getting Started

Usage

Configuration
Convention
Markdown
MDX
Internationalization
API Documentation
Permission Description Document
Referencing Documents
Deployment

APIs

Advanced API

Event APIs

Search

Log APIs

Aggregation
Search
CodeQualityTaskSummary
Projects

CRDs

ArtifactCleanupRun

Public References

CodeQuality
CodeQualityBranch
📝 Edit this page on GitHub
Previous PageConvention
Next PageMDX

#Markdown

In addition to the standard gfm syntax, Doom has built-in some extra Markdown extension features.

#TOC

#Callouts

Source code annotation components

NOTE
  1. Please use inline code comments according to the actual language, such as ;, %, #, //, /** */, --, and <!-- -->, etc.
  2. If you want to treat them as code comments, please escape them with [\!code callout].
  3. Sometimes, :::callouts may display abnormally due to nested indentation; you can use <div class="doom-callouts"> or the <Callouts> component instead.
```sh
Memory overhead per virtual machine ≈ (1.002 × requested memory) \
              + 218 MiB \  # [!code callout]
              + 8 MiB × (number of vCPUs) \  # [!code callout]
              + 16 MiB × (number of graphics devices) \  # [!code callout]
              + (additional memory overhead) # [!code callout]
```

:::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) 
  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.

For more source code transformation features, please refer to Shiki Transformers.

#Mermaid

Chart drawing tool

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

With Markdown Preview Mermaid, you can preview in real time in VSCode.

#Attribute Extensions

WARNING

Currently only supported in .md files, see related issue

![](/logo.svg){width="100" height="100"}