• setup
• usage
  • collapse
  • table
  • card
  • banner

[!NOTE|label:references:]

• Customizable HTML Formatter

setup

1. go to Manage Jenkins → Security → Markup Formatter, and select Customizable HTML Formatter

2. go to Manage Jenkins → Configure System → Customizable HTML Formatter Plugin, and add the following content into the Policy

   [
     {
       "type": "inbuilt",
       "name": "blocks, formatting, styles, tables, images"
     },
     {
       "type": "new",
       "allow": {
         "dl, dt, dd, hr": "",
         "details, summary": "",
         "pre, code": "",
         "div, span": "style, class",
         "font": "size, color",
         "table": "class",
         "thead, tbody, tr": "",
         "th": "class",
         "td": "class",
         "a": "href, target, class, rel",
         "svg": "xmlns, viewBox, aria-hidden, style",
         "ellipse": "cx, cy, rx, ry, fill, stroke, stroke-linecap, stroke-miterlimit, stroke-width",
         "path": "d, fill, stroke, stroke-linecap, stroke-linejoin, stroke-width"
       },
       "methods": {
         "allowStandardUrlProtocols": ""
       }
     }
   ]
   

usage

collapse

// policy
[
 {
   "type": "inbuilt",
   "name": "blocks, formatting, styles, links, tables, images"
 },
 {
   "type": "new",
   "allow": {
     "dl, dt, dd, hr": "",
     "details, summary": "",
     "pre, code": "",
     "div, span": "style",
     "font": "size, color"
   }
 }
]

addSummary(
  icon: 'symbol-terminal-outline plugin-ionicons-api',
  text: '<h4>collapse test</h4>' +
        '<details>' +
          '<summary>click to expand details ...</summary>' +
          '<pre><code>' +
            'abc123  file1.tar.bz2<br>' +
            'def456  file2.tar.bz2<br>' +
            '789ghi  file3.tar.bz2<br>' +
          '</code></pre>' +
        '</details>'
)

// or fancy version
Map<String, String> styles = [
  pre      : 'display:block;background-color:#FAFBFC;color:#24292E;padding:8px 16px;border-radius:12px;border:1px solid #E1E4E8;font-size:13px;overflow-x:auto;box-shadow:0 4px 12px rgba(0,0,0,0.1),0 1px 3px rgba(0,0,0,0.06)',
  monofont : 'font-family: var(--font-family-mono, ui-monospace, SFMono-Regular, "Cascadia Code", Consolas, Menlo, Monaco, monospace)',
  summary  : 'cursor:pointer;color:#0366D6;font-weight:bold;padding:6px 12px;background-color:#F1F8FF;border-radius:6px'
]

String body = '''
              abc123  file1.tar.bz2
              def456  file2.tar.bz2
              789ghi  file3.tar.bz2
              '''.stripIndent().trim()
String html = "<pre style=\"${styles.pre};${styles.monofont}\"><code style=\"font-family:inherit;\">${body}</code></pre>"
html        = "<details style=\"margin-bottom:16px;\"><summary style=\"${styles.summary}\">click to expand details ...</summary>${html}</details>"
html        = "<h4>collapse test</h4>${html}"

addSummary icon: 'symbol-terminal-outline plugin-ionicons-api', text: html

table

[!NOTE|label:references:]

• customizable-header plugin/Design Library/Table
  • class="jenkins-table sortable": make the table sortable by clicking the header

// policy
[
  {
    "type": "inbuilt",
    "name": "blocks, formatting, styles, links, tables, images"
  },
  {
    "type": "new",
    "allow": {
      "dl, dt, dd, hr": "",
      "details, summary": "",
      "pre, code": "",
      "div, span": "style, class",
      "font": "size, color",
      "table": "class",
      "thead, tbody, tr": "",
      "th": "class",
      "td": "class",
      "a": "href, class, rel",
      "svg": "xmlns, viewBox, aria-hidden, style",
      "ellipse": "cx, cy, rx, ry, fill, stroke, stroke-linecap, stroke-miterlimit, stroke-width",
      "path": "d, fill, stroke, stroke-linecap, stroke-linejoin, stroke-width"
    }
  }
]

// jenkinsfile
Closure svgs = { String color ->
  [
    blue   : '''<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" viewBox="0 0 512 512" style="width:20px; height:20px;"><ellipse cx="256" cy="256" fill="none" rx="210" ry="210" stroke="var(--success-color)" stroke-linecap="round" stroke-miterlimit="10" stroke-width="36"></ellipse><path d="M336 189L224 323L176 269.4" fill="transparent" stroke="var(--success-color)" stroke-linecap="round" stroke-linejoin="round" stroke-width="36"></path></svg>''',
    red    : '''<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" viewBox="0 0 512 512" style="width:20px; height:20px;"><ellipse cx="256" cy="256" fill="none" rx="210" ry="210" stroke="var(--red)" stroke-linecap="round" stroke-miterlimit="10" stroke-width="36"></ellipse><path d="M320 320L192 192M192 320l128-128" fill="none" stroke="var(--red)" stroke-linecap="round" stroke-linejoin="round" stroke-width="36"></path></svg>''',
    yellow : '''<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" viewBox="0 0 512 512" style="width:20px; height:20px;"><ellipse cx="256" cy="256" fill="none" rx="210" ry="210" stroke="var(--orange)" stroke-linecap="round" stroke-miterlimit="10" stroke-width="36"></ellipse><path d="M250.26 166.05L256 288l5.73-121.95a5.74 5.74 0 00-5.79-6h0a5.74 5.74 0 00-5.68 6z" fill="none" stroke="var(--orange)" stroke-linecap="round" stroke-linejoin="round" stroke-width="36"></path><ellipse cx="256" cy="350" fill="var(--orange)" rx="26" ry="26"></ellipse></svg>'''
  ].get( color, '' )
}

addSummary icon: 'symbol-terminal',
           text: """
                 <table class="jenkins-table sortable">
                   <thead>
                     <tr><th>Name</th><th>S</th><th>Status</th><th>Reason</th></tr>
                   </thead>
                   <tbody>
                     <tr>
                       <td><a href="#" class="jenkins-table__link">Link 1</a></td>
                       <td class="jenkins-table__cell">${svgs('blue')}</td>
                       <td>Success <a href="#">#7</a></td>
                       <td>No Errors</td>
                     </tr>
                     <tr>
                       <td><a href="#" class="jenkins-table__link">Link 2</a></td>
                       <td class="jenkins-table__cell">${svgs('red')}</td>
                       <td>Failure</td>
                       <td>Can't compile</td>
                     </tr>
                     <tr>
                       <td><a href="#" class="jenkins-table__link">Link 3</a></td>
                       <td class="jenkins-table__cell">${svgs('yellow')}</td>
                       <td>Unstable</td>
                       <td>Test Failed</td>
                     </tr>
                   </tbody>
                 </table>
                 """.stripIndent()

card

<!-- ⑨ Yellow左侧色条 -->
<div style="background:linear-gradient(135deg,#fffdf5 0%,#fef3d0 100%); border-left:4px solid #EF9F27; border-radius:0 10px 10px 0; box-shadow:0 8px 28px rgba(239,159,39,.2); padding:1rem 1.25rem; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <div style="margin-bottom:7px;">
    <span style="font-size:1.2rem; color:#854F0B; margin-right:6px;">&#9888;</span><span style="font-weight:700; letter-spacing:.07em; color:#633806;">IMPORTANT NOTICE</span>
  </div>
  <ul style="margin:0; padding-left:1.3rem; line-height:1.8; color:#854F0B;">
    <li><code style="background:#FAC775; color:#412402; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#412402; font-weight:700;"><code style="background:#FAC775; color:#412402; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
    <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#412402; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:#FAC775; color:#412402; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
  </ul>
</div>

<!-- ① Blue 左侧色条 -->
<div style="background:linear-gradient(135deg,#e6f1fb 0%,#cce3f8 100%); border-left:4px solid #378ADD; border-radius:0 10px 10px 0; box-shadow:-4px 8px 28px rgba(55,138,221,.25); padding:1rem 1.25rem; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <p style="font-size:11px; font-weight:700; letter-spacing:.07em; color:#185FA5; margin:0 0 7px;">NOTICE</p>
  <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#0C447C;">
    <li><code style="background:#B5D4F4; color:#042C53; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#042C53; font-weight:700;"><code style="background:#B5D4F4; color:#042C53; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
    <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#042C53; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:#B5D4F4; color:#042C53; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
  </ul>
</div>

<!-- ② Amber 全边框 + 警告图标 -->
<div style="background:linear-gradient(135deg,#fff8ee 0%,#faeeda 100%); border-radius:10px; border:1.5px solid #EF9F27; box-shadow:0 8px 28px rgba(239,159,39,.3); padding:1rem 1.25rem; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif; display:flex; gap:12px; align-items:flex-start;">
  <span style="font-size:20px; color:#854F0B; flex-shrink:0; margin-top:2px;">&#9888;</span>
  <div>
    <p style="font-size:11px; font-weight:700; letter-spacing:.07em; color:#633806; margin:0 0 7px;">IMPORTANT NOTICE</p>
    <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#854F0B;">
      <li><code style="background:#FAC775; color:#412402; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#412402; font-weight:700;"><code style="background:#FAC775; color:#412402; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
      <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#412402; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:#FAC775; color:#412402; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
    </ul>
  </div>
</div>

<!-- ③ Teal 胶囊 badge -->
<div style="background:linear-gradient(135deg,#e1f5ee 0%,#9FE1CB 100%); border-radius:10px; border:1px solid #5DCAA5; box-shadow:0 8px 28px rgba(29,158,117,.25); padding:1rem 1.25rem; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <div style="margin-bottom:8px;">
    <span style="background:#1D9E75; color:#E1F5EE; font-size:11px; font-weight:700; padding:2px 10px; border-radius:20px; letter-spacing:.04em;">NOTICE</span>
  </div>
  <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#0F6E56;">
    <li><code style="background:rgba(255,255,255,.6); color:#04342C; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#04342C; font-weight:700;"><code style="background:rgba(255,255,255,.6); color:#04342C; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
    <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#04342C; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:rgba(255,255,255,.6); color:#04342C; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
  </ul>
</div>

<!-- ④ Coral 顶部色条 -->
<div style="background:linear-gradient(135deg,#faece7 0%,#f5c4b3 60%,#f0997b 100%); border-radius:0 0 10px 10px; border-top:3px solid #D85A30; box-shadow:0 8px 28px rgba(216,90,48,.25); padding:1rem 1.25rem; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <div style="display:flex; align-items:center; gap:6px; margin-bottom:8px;">
    <span style="font-size:16px; color:#712B13;">&#8505;</span>
    <p style="font-size:11px; font-weight:700; letter-spacing:.07em; color:#712B13; margin:0;">NOTICE</p>
  </div>
  <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#993C1D;">
    <li><code style="background:rgba(255,255,255,.5); color:#4A1B0C; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#4A1B0C; font-weight:700;"><code style="background:rgba(255,255,255,.5); color:#4A1B0C; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
    <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#4A1B0C; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:rgba(255,255,255,.5); color:#4A1B0C; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
  </ul>
</div>

<!-- ⑤ Purple 填充 header 条 -->
<div style="border-radius:10px; overflow:hidden; border:1px solid #AFA9EC; box-shadow:0 8px 28px rgba(83,74,183,.3); margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <div style="background:linear-gradient(90deg,#534AB7,#7F77DD); padding:.6rem 1.25rem;">
    <span style="font-size:11px; font-weight:700; letter-spacing:.07em; color:#EEEDFE;">&#128276; NOTICE</span>
  </div>
  <div style="background:#EEEDFE; padding:1rem 1.25rem;">
    <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#3C3489;">
      <li><code style="background:#CECBF6; color:#26215C; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#3C3489; font-weight:700;"><code style="background:#CECBF6; color:#26215C; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
      <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#3C3489; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:#CECBF6; color:#26215C; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
    </ul>
  </div>
</div>

<!-- ⑥ Gray 分隔线风格 -->
<div style="background:linear-gradient(135deg,#f1efe8 0%,#d3d1c7 100%); border-radius:10px; border:.5px solid #B4B2A9; box-shadow:0 8px 24px rgba(96,95,90,.2); overflow:hidden; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <div style="background:#e8e6df; padding:.6rem 1.25rem; border-bottom:.5px solid #B4B2A9;">
    <span style="font-size:11px; font-weight:700; letter-spacing:.07em; color:#5F5E5A;">&#128227; NOTICE</span>
  </div>
  <div style="padding:.9rem 1.25rem;">
    <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#444441;">
      <li><code style="background:rgba(255,255,255,.7); color:#2C2C2A; padding:1px 6px; border-radius:4px; border:.5px solid #B4B2A9;">OLD_NAME</code> renamed to <a href="#" style="color:#2C2C2A; font-weight:700;"><code style="background:rgba(255,255,255,.7); color:#2C2C2A; padding:1px 6px; border-radius:4px; border:.5px solid #B4B2A9;">NEW_NAME</code></a></li>
      <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#2C2C2A; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:rgba(255,255,255,.7); color:#2C2C2A; padding:1px 6px; border-radius:4px; border:.5px solid #B4B2A9;">JVM v17</code> — same version as the controller</li>
    </ul>
  </div>
</div>

<!-- ⑦ Pink 左侧色条 -->
<div style="background:linear-gradient(135deg,#fbeaf0 0%,#f4c0d1 100%); border-left:4px solid #D4537E; border-radius:0 10px 10px 0; box-shadow:-4px 8px 28px rgba(212,83,126,.25); padding:1rem 1.25rem; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <div style="display:flex; align-items:center; gap:6px; margin-bottom:7px;">
    <span style="font-size:14px; color:#72243E;">&#9873;</span>
    <p style="font-size:11px; font-weight:700; letter-spacing:.07em; color:#72243E; margin:0;">NOTICE</p>
  </div>
  <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#993556;">
    <li><code style="background:rgba(255,255,255,.55); color:#4B1528; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#4B1528; font-weight:700;"><code style="background:rgba(255,255,255,.55); color:#4B1528; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
    <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#4B1528; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:rgba(255,255,255,.55); color:#4B1528; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
  </ul>
</div>

<!-- ⑧ Green 胶囊 badge -->
<div style="background:linear-gradient(135deg,#eaf3de 0%,#C0DD97 100%); border-radius:10px; border:1px solid #97C459; box-shadow:0 8px 28px rgba(99,153,34,.25); padding:1rem 1.25rem; margin-bottom:1rem; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
  <div style="margin-bottom:8px;">
    <span style="background:#639922; color:#EAF3DE; font-size:11px; font-weight:700; padding:2px 10px; border-radius:20px; letter-spacing:.04em;">NOTICE</span>
  </div>
  <ul style="margin:0; padding-left:1.3rem; font-size:14px; line-height:1.8; color:#3B6D11;">
    <li><code style="background:rgba(255,255,255,.6); color:#173404; padding:1px 6px; border-radius:4px;">OLD_NAME</code> renamed to <a href="#" style="color:#173404; font-weight:700;"><code style="background:rgba(255,255,255,.6); color:#173404; padding:1px 6px; border-radius:4px;">NEW_NAME</code></a></li>
    <li><a href="https://www.jenkins.io/doc/book/platform-information/upgrade-java-to-17/index.html#jvm-version-on-agents" style="color:#173404; font-weight:700;">JVM version on agents</a>: all agents must run <code style="background:rgba(255,255,255,.6); color:#173404; padding:1px 6px; border-radius:4px;">JVM v17</code> — same version as the controller</li>
  </ul>
</div>

<div style="display:block; width:1200px; border-radius:12px; background:linear-gradient(135deg, #4a8c5c, #5da06d, #78b888); box-shadow:0 6px 20px rgba(74,140,92,0.25); padding:20px 28px; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif; box-sizing:border-box;">
  <div style="font-size:1.2em; color:#d4edda; text-transform:uppercase; letter-spacing:1.5px; font-weight:700; margin-bottom:8px;">
    Documentation
  </div>
  <div style="font-size:16px; color:#f0f9f2; line-height:1.5; margin-bottom:14px;">
    Pipeline usage, parameters, and configuration guide.
  </div>
  <a href="#" target="_blank" style="display:inline-block; padding:8px 20px; border-radius:6px; background:linear-gradient(90deg, #81c784, #aed581); color:#1b3d24; text-decoration:none; font-size:14px; font-weight:700; letter-spacing:0.3px;">
    Open Confluence &#8599;
  </a>
</div>
<div style="display:block; width:1200px; margin-top:12px; border-left:4px solid #6a1b9a; border-radius:0 8px 8px 0; background:linear-gradient(135deg, #f3e5f5, #e1bee7); box-shadow:0 6px 20px rgba(106,27,154,0.15); padding:16px 20px; font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif; box-sizing:border-box;">
  <div style="font-size:1.2em; color:#6a1b9a; text-transform:uppercase; letter-spacing:1.2px; font-weight:700; margin-bottom:10px;">&#9888; Mandatory Requirements</div>
  <ol style="margin:0; padding-left:36px; font-size:14px; color:#311b42; line-height:1.8;">
    <li><span style="color:#c62828; font-weight:600;">Branch protection rules</span> MUST be enabled in the REPO</li>
    <li>Service account <a href="#" target="_blank" style="color:#6a1b9a; font-weight:600;">&lt;ACCOUNT&gt;</a> MUST be in <span style="color:#ad1457; font-weight:600;">ADMIN</span> role in the REPO, or add Team <a href="#" target="_blank" style="color:#6a1b9a; font-weight:600;">organization/team</a> as <span style="color:#ad1457; font-weight:600;">ADMIN</span> role</li>
  </ol>
</div>

banner

[!NOTE|label:references:]

• customizable-header plugin/Design Library/Banner

Closure banner = { String message, String type = 'info' ->
  Map<String, Map<String, String>> colors = [
    warning: [ bg: '#fff3cd', color: '#856404', border: '#ffeeba' ],
    info:    [ bg: '#d1ecf1', color: '#0c5460', border: '#bee5eb' ],
    danger:  [ bg: '#f8d7da', color: '#721c24', border: '#f5c6cb' ],
    success: [ bg: '#CAE4CC', color: '#51a556', border: '#CFE6D1' ]
  ]
  Map<String, String> style = colors.getOrDefault( type.toLowerCase(), 'info' )

  """
  <div style="background-color: ${style.bg}; color: ${style.color}; border: 1px solid ${style.border}; padding: 10px; border-radius: 5px; margin: 10px 0; font-family: sans-serif;">
      <strong>${type.toUpperCase()}：</strong> ${message}
  </div>
  """.stripIndent().trim()
}

addSummary icon: 'symbol-status-yellow' , text: banner('this is a warning'     , 'warning' )
addSummary icon: 'symbol-details'       , text: banner('this is a information' , 'info'    )
addSummary icon: 'symbol-status-blue'   , text: banner('this is a success'     , 'success' )
addSummary icon: 'symbol-status-red'    , text: banner('this is a danger'      , 'danger'  )