Skip to content

Latest commit

 

History

History
270 lines (224 loc) · 5.13 KB

markdown-custom.md

File metadata and controls

270 lines (224 loc) · 5.13 KB
Raw

OVH markdown custom content

notices

alert

/* markdown */

> [!alert]
>
> this is an alert!
>
<!-- generated html -->

<div class="callout alert">
  <p>this is an alert!</p>
</div>

alert notice

Other notices

primary

/* markdown */

> [!primary]
>
> this is a primary notice!
>

alert notice

warning

/* markdown */

> [!warning]
>
> this is a warning!
>

alert notice

info

/* markdown */

> [!info]
>
> this is a simple notice!
>

alert notice

Carousel

/* markdown */

> [!carousel]
>
> - ![caption of image 1](images/01.jpg)
> - ![caption of image 2](images/02.jpg)
> - ![caption of image 3](images/03.jpg)
>
<!-- generated html -->

<div class="carousel">
    <div>
        <img alt="caption of image 1" class="carousel-image" src="images/01.png"/>
        <figcaption class="carousel-caption">caption of image 1</figcaption>
    </div>
    <div>
        <img alt="caption of image 2" class="carousel-image" src="images/02.png"/>
        <figcaption class="carousel-caption">caption of image 2</figcaption>
    </div>
    <div>
        <img alt="caption of image 3" class="carousel-image" src="images/03.png"/>
        <figcaption class="carousel-caption">caption of image 3</figcaption>
    </div>
</div>

carousel

FAQ

/* markdown */

> [!faq]
>
> Question 1
>> Response 1
> Question 2
>> - item 1
>> - item 2
> Question 3
>> col 3-1-1
>>> col 3-1-2
>> col 3-2-1
>>> col 3-2-2
>> col 3-3-1
>>> col 3-3-2
<!-- generated html -->

<dl class="docutils">
    <dt><em>Question 1</em></dt>
    <dd>
        <p>Asnwer 1</p>
    </dd>
    <dt><em>Question 2</em></dt>
    <dd>
        <ul>
            <li>Asnwer 2-1</li>
            <li>Asnwer 2-2</li>
        </ul>
    </dd>
    <dt><em>Question 3</em></dt>
    <dd>
        <table class="first last docutils field-list">
            <tbody>
                <tr class="field">
                    <th class="field-name">answer col 3-1-1</th>
                    <td class="field-body">
                        <p>answer col 3-1-2</p>
                    </td>
                </tr>
                <tr class="field">
                    <th class="field-name">answer col 3-2-1</th>
                    <td class="field-body">
                        <p>answer col 3-2-2</p>
                    </td>
                </tr>
                <tr class="field">
                    <th class="field-name">answer col 3-3-1</th>
                    <td class="field-body">
                        <p>answer col 3-3-2</p>
                    </td>
                </tr>
            </tbody>
        </table>
    </dd>
</dl>

faq

Api

/* markdown */

> [!api]
>
> @api {POST} /ipLoadbalancing/{serviceName}/tcp/route
>
<!-- generated html -->

<div class="ovh-api-main">
  <a href="https://eu.api.ovh.com/console/#/ipLoadbalancing/{serviceName}/tcp/route#POST" target="_blank">
    <span class="ovh-api-verb ovh-api-verb-POST">POST</span>
    <span class="ovh-api-endpoint">/ipLoadbalancing/{serviceName}/tcp/route</span>
  </a>
</div>

api

Advanced

You can mix different custom syntax

/* markdown */

> [!faq]
>
> Service:
>
>> > [!api]
>> >
>> > @api {POST} /ipLoadbalancing/{serviceName}/tcp/route
>> >
>>
>
> Paramètres:
>
>> serviceName *
>>> Nom du service IP Load Balancer concerné de la forme `ip-a.b.c.d`
>> action.type
>>> Mettre "farm"
>> action.target
>>> &lt;id de votre ferme tcp qui doit savoir gérer le HTTP/2&gt;
>> frontendId
>>> &lt;id de votre frontend tcp 443&gt;
<!-- generated html -->

<dl class="docutils">
  <dt><em>Service:</em></dt>
  <dd>
    <div class="ovh-api">
      <p>
        <div class="ovh-api-main">
          <a href="https://eu.api.ovh.com/console/#/ipLoadbalancing/{serviceName}/tcp/route#POST" target="_blank">
            <span class="ovh-api-verb ovh-api-verb-POST">POST</span>
            <span class="ovh-api-endpoint">/ipLoadbalancing/{serviceName}/tcp/route</span>
          </a>
        </div>
      </p>
    </div>
  </dd>
  <dt><em>Param&egrave;tres:</em></dt>
  <dd>
    <table class="first last docutils field-list">
      <tr class="field">
        <th class="field-name">serviceName *</th>
        <td class="field-body">
          <p>Nom du service IP Load Balancer concern&eacute; de la forme <code>ip-a.b.c.d</code></p>
        </td>
      </tr>
      <tr class="field">
        <th class="field-name">action.type</th>
        <td class="field-body">
          <p>Mettre "farm"</p>
        </td>
      </tr>
      <tr class="field">
        <th class="field-name">action.target</th>
        <td class="field-body">
          <p>&lt;id de votre ferme tcp qui doit savoir g&eacute;rer le HTTP/2&gt;</p>
        </td>
      </tr>
      <tr class="field">
        <th class="field-name">frontendId</th>
        <td class="field-body">
          <p>&lt;id de votre frontend tcp 443&gt;</p>
        </td>
      </tr>
    </table>
  </dd>
</dl>

custom