CARVIEW |
Select Language
HTTP/2 200
date: Thu, 31 Jul 2025 13:40:13 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-robots-tag: none
etag: W/"df49331671c856129815248cc7336570"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com wss://alive-staging.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=i7n1LnSXzuoPFpmJfC%2F0jkGkFVqF0YEX3V%2F7Q3DTXpMT5Ifam0LeEnl5porUc5BxTxfs%2B8DGZJCSlXFYjN7O6RMy%2BdbIpNlTOTsUa0yAIiV2zM8WHRyynXLjyajicdwv4%2F0R9mJdivsMxkmvHIRvoiiWWIG%2BCw3fLVnzirtIX84EjyLf4fLuZ5wVJtPcokzy3cFHYHBbwbGGhupaqhxx%2BwK%2BN5Is8VHPqzNesLJCKgIXMpBXQxv2Wlk4Eq6W79MZ%2FlUbfOPaqoEczaPFhlwftQ%3D%3D--9Hdsz7wvF3gLXavO--NXLY1%2F3TX966WsJt2laslw%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.60550009.1753969212; Path=/; Domain=github.com; Expires=Fri, 31 Jul 2026 13:40:12 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Fri, 31 Jul 2026 13:40:12 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: BFE6:2C0AA0:B34908:D3E0E9:688B723C
admonitions · trentm/python-markdown2 Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 438
admonitions
Crozzers edited this page Apr 27, 2023
·
1 revision
Added in version 2.4.3, the admonitions
extra adds support for ReST admonitions. Taken from the ReST directives documentation:
Admonitions ("safety messages" or "hazard statements") can appear anywhere an ordinary body element can. They contain arbitrary body elements. Typically, an admonition is rendered as an offset block in a document, sometimes outlined or shaded.
The general syntax is as follows:
.. [TYPE]:: [Optional title]
[Body, indented by 3 spaces or more]
The allowed admonition types are defined here.
.. NOTE:: Admonitions
They contain 3 main parts, the admonition type (the bit before the "::"),
title (the bit after the "::") and body (the text underneath).
The admonition type is case insensitive, title is optional and the body
should be able to contain pretty much anything. For example:
- Lists
- With multiple levels
- Of indentation
And code blocks:
print('indented code blocks')
.. warning::
The admonition's body must be indented by a tab or 3 or more spaces
from where the admonition was declared
This line is indented by only 2 spaces, and so isn't part of the admonition.
.. IMPORTANT::
You can also use 3 or more empty lines after an admonition
to end it
print('In case you wanted something like')
print('an indented code block right after')
.. admonition:: Generic admonitions
These should be given a title but this is not enforced
.. note:: Nested admonitions
Nested admonitions should also work
- Even inside
.. tip::
of a list
markdown2.markdown(your_text, extras=['admonitions'])
python lib/markdown2.py -x admonitions foo.txt
.. warning:: Deprecated
Feature XYZ was deprecated in version 1.2.3
.. info::
Without a title
The above admonition will look something like this:
<aside class="admonition warning">
<strong>warning</strong>
<em>Deprecated</em>
<p>Feature XYZ was deprecated in version 1.2.3</p>
</aside>
<aside class="admonition info">
<strong>info</strong>
<p>Without a title</p>
</aside>
You can’t perform that action at this time.