Public-Mirrors
/
markdown-it
mirror of https://github.com/markdown-it/markdown-it.git
1
0
Fork 0
Code Issues Releases Activity
Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed https://markdown-it.github.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
2 Branches
79 Tags
4.1 MiB
Tree: 6dc392cf0f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6dc392cf0f'
${ noResults }
markdown-it/index.html

1632 lines
265 KiB
Raw Normal View History

Updates
8 months ago
<!DOCTYPE html><html><head><title>markdown-it 14.1.0 API documentation</title><meta charset="utf-8"><meta name="generator" content="ndoc"><style rel="stylesheet">article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
nav,
section {
display: block;
}
audio,
canvas,
video {
display: inline-block;
*display: inline;
*zoom: 1;
}
audio:not([controls]) {
display: none;
}
html {
font-size: 100%;
-webkit-text-size-adjust: 100%;
-ms-text-size-adjust: 100%;
}
a:hover,
a:active {
outline: 0;
}
sub,
sup {
position: relative;
font-size: 75%;
line-height: 0;
vertical-align: baseline;
}
sup {
top: -0.5em;
}
sub {
bottom: -0.25em;
}
img {
max-width: 100%;
height: auto;
border: 0;
-ms-interpolation-mode: bicubic;
}
button,
input,
select,
textarea {
margin: 0;
font-size: 100%;
vertical-align: middle;
}
button,
input {
*overflow: visible;
line-height: normal;
}
button::-moz-focus-inner,
input::-moz-focus-inner {
padding: 0;
border: 0;
}
button,
input[type="button"],
input[type="reset"],
input[type="submit"] {
cursor: pointer;
-webkit-appearance: button;
}
input[type="search"] {
-webkit-appearance: textfield;
box-sizing: content-box;
}
input[type="search"]::-webkit-search-decoration,
input[type="search"]::-webkit-search-cancel-button {
-webkit-appearance: none;
}
textarea {
overflow: auto;
vertical-align: top;
}
p {
margin: 0 0 11px;
font-family: Verdana, sans-serif;
font-size: 14px;
line-height: 22px;
}
p small {
font-size: 12px;
color: #999;
}
.lead {
margin-bottom: 22px;
font-size: 20px;
font-weight: 200;
line-height: 33px;
}
h1,
h2,
h3,
h4,
h5,
h6 {
margin: 0;
font-weight: normal;
color: #444;
text-rendering: optimizelegibility;
}
h1 small,
h2 small,
h3 small,
h4 small,
h5 small,
h6 small {
font-weight: normal;
color: #999;
}
h1 {
font-size: 36px;
line-height: 55px;
}
h1 small {
font-size: 18px;
}
h2 {
font-size: 30px;
line-height: 44px;
}
h2 small {
font-size: 18px;
}
h3 {
line-height: 44px;
font-size: 24px;
}
h3 small {
font-size: 18px;
}
h4,
h5,
h6 {
line-height: 22px;
}
h4 {
line-height: 33px;
font-size: 18px;
}
h4 small {
font-size: 14px;
}
h5 {
font-size: 14px;
}
h6 {
font-size: 12px;
color: #999;
text-transform: uppercase;
}
.page-header {
padding-bottom: 21px;
margin: 22px 0;
border-bottom: 1px solid #ccc;
}
.page-header h1 {
line-height: 1;
}
ul,
ol {
padding: 0;
margin: 0 0 11px 25px;
}
ul ul,
ul ol,
ol ol,
ol ul {
margin-bottom: 0;
}
ul {
list-style: disc;
}
ol {
list-style: decimal;
}
li {
line-height: 22px;
}
ul.unstyled,
ol.unstyled {
margin-left: 0;
list-style: none;
}
dl {
margin-bottom: 22px;
}
dt,
dd {
line-height: 22px;
}
dt {
font-weight: bold;
}
dd {
margin-left: 11px;
}
hr {
margin: 22px 0;
border: 0;
border-top: 1px solid hrBorder;
border-bottom: 1px solid #fff;
}
strong {
font-weight: bold;
}
em {
font-style: italic;
}
.muted {
color: #999;
}
abbr {
font-size: 90%;
text-transform: uppercase;
border-bottom: 1px dotted #ddd;
cursor: help;
}
blockquote {
padding: 0 0 0 15px;
margin: 0 0 22px;
border-left: 5px solid #ccc;
}
blockquote p {
margin-bottom: 0;
}
blockquote small {
display: block;
line-height: 22px;
color: #999;
}
blockquote small:before {
content: '\2014 \00A0';
}
blockquote.pull-right {
float: right;
padding-left: 0;
padding-right: 15px;
border-left: 0;
border-right: 5px solid #ccc;
}
blockquote.pull-right p,
blockquote.pull-right small {
text-align: right;
}
q:before,
q:after,
blockquote:before,
blockquote:after {
content: "";
}
address {
display: block;
margin-bottom: 22px;
line-height: 22px;
font-style: normal;
}
small {
font-size: 100%;
}
cite {
font-style: normal;
}
body {
margin: 0;
font-family: Verdana, sans-serif;
font-size: 14px;
line-height: 22px;
color: #444;
background-color: #fff;
overflow-x: hidden;
}
a {
color: #036;
text-decoration: none;
border-bottom: 1px solid #999;
}
a:hover {
color: #800;
border-color: #800;
}
.main {
padding-left: 390px;
width: 600px;
}
.sidebar {
background: #f8f8f8;
position: fixed;
top: 0;
bottom: 0;
left: 0;
width: 240px;
overflow: hidden;
}
#search {
background-color: #eee;
padding: 7px 0;
height: 30px;
box-shadow: 0 0 5px #aaa;
}
#search input {
width: 90%;
margin: auto;
margin-top: 3px;
padding: 4px;
display: block;
background-color: #f8f8f8;
border: 0px none;
border-radius: 3px;
box-shadow: 0 0 2px #666 inset;
}
#search-results {
z-index: 1000;
background-color: #f8fcf8;
display: none;
}
.footer {
border-top: 1px solid #eee;
font-size: 10px;
opacity: 0.5;
}
.gh-ribbon {
position: absolute;
right: -60px;
top: 44px;
z-index: 10000;
background-color: #686868;
padding: 1px 0;
transform: rotate(45deg);
width: 230px;
box-shadow: 0 0 2px rgba(102,102,102,0.4);
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
}
.gh-ribbon a {
display: block;
color: #fff;
text-decoration: none;
border: 1px solid #ccc;
font-size: 13px;
font-weight: bold;
padding: 4px 50px 2px;
text-align: center;
outline: none;
}
.gh-ribbon a:hover {
text-decoration: none;
}
.csstransforms .gh-ribbon {
display: block;
}
.menu {
padding: 0;
margin: 0;
list-style: none;
top: 45px;
bottom: 0;
position: absolute;
overflow-x: hidden;
overflow-y: auto;
width: 240px;
}
.menu a {
border: 0;
padding: 3px 10px 3px 28px;
background-position: 6px 50%;
background-repeat: no-repeat;
display: block;
transition: all 0.3s ease;
color: #333;
display: block;
text-align: left;
text-decoration: none;
white-space: nowrap;
}
.menu a.deprecated {
opacity: 0.5;
}
.menu a.current {
background-color: #ddd;
}
.menu a.current-parent {
background-color: #eee;
}
.menu a:hover {
background-color: #ccc;
}
.menu a.section {
background-color: #000;
background: linear-gradient(#000 70%, #444) repeat scroll 0 0 transparent;
color: #ccc;
font-weight: bold;
padding: 6px 10px 6px 28px;
}
.menu a.class {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHhSURBVDjLpZI9SJVxFMZ/r2YFflw/kcQsiJt5b1ije0tDtbQ3GtFQYwVNFbQ1ujRFa1MUJKQ4VhYqd7K4gopK3UIly+57nnMaXjHjqotnOfDnnOd/nt85SURwkDi02+ODqbsldxUlD0mvHw09ubSXQF1t8512nGJ/Uz/5lnxi0tB+E9QI3D//+EfVqhtppGxUNzCzmf0Ekojg4fS9cBeSoyzHQNuZxNyYXp5ZM5Mk1ZkZT688b6thIBenG/N4OB5B4InciYBCVyGnEBHO+/LH3SFKQuF4OEs/51ndXMXC8Ajqknrcg1O5PGa2h4CJUqVES0OO7sYevv2qoFBmJ/4gF4boaOrg6rPLYWaYiVfDo0my8w5uj12PQleB0vcp5I6HsHAUoqUhR29zH+5B4IxNTvDmxljy3x2YCYUwZVlbzXJh9UKeQY6t2m0Lt94Oh5loPdqK3EkjzZi4MM/Y9Db3MTv/mYWVxaqkw9IOATNR7B5ABHPrZQrtg9sb8XDKa1+QOwsri4zeHD9SAzE1wxBTXz9xtvMc5ZU5lirLSKIz18nJnhOZjb22YKkhd4odg5icpcoyL669TAAujlyIvmPHSWXY1ti1AmZ8mJ3ElP1ips1/YM3H300g+W+51nc95YPEX8fEbdA2ReVYAAAAAElFTkSuQmCC");
}
.menu a.class-method {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAXRQTFRFvLXSuLHQwrzWsKjKxb/YrKTIq6PHr6fKta7OnpS+tKzN/v7+pp3EpZzD2tbmurPRh3uvx8HZzsneopnBjIGx3NnoxL7Y0czgjoO09fT4iHyw0Mvf4d7r0s7hoZjBmI67xsDZy8bcrqbJ3t3hdGmcZ1uQ7evzt7DMysXcqqW7in+xqJ/FtK3Nm5G9lou5nJK99/b6urbHUUlnyMLaTUNvwrzX5OHtgHyMXVhx5uTut6/PubLQ0s/d3tvpNS5LgnmjTkZlTUZmVU1vUklu7Ovv1dLgWU1/fG+o9PT2r6jGY1aObGaAn5uwVk5xkIW129fnvbfT/Pv9TEJsrqfJc2aeRDtgf3WhwLrVi3+ynZW2mo+819Tlp57Ea2CRvbbTin6x7+7yb2OV+fn72dXlTkRw2NTllIm4q6LHfG+mT0Vx29jnZ2J4k4m4mY+8VEp19fX31NDj////npup4+Hpgnas3droXlKIsa661NHfpqG1s6vM////z9cmxgAAAHx0Uk5T////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////AAFq2jEAAADzSURBVHjaYqgGAzMFplIIiwGIJQMLrbP45LmT1CAC0QwMBlWy4nKSuVpVIAEZaUuhYB5BlrQcRltOdaCAqJI0i6KQIIsiE6OOmyZISwELP4ewewlrFRunJ1CLqRW7BgOvvU2FiBIrQ4hKGAO7jCBHnIBrdbWoH7twlXgQg3YqUxWDXnJ1NV8EK2c6UyiDboZAQBV/lD+fCBuvnLORBdBQMWY2Zi6JeLYYfQkfkDuMBRSYGcM5uPiZeRhTKoECYryyUqpe7KwmeVJMZUUgd0Rm+iYkMnI5uTjYmUM8V5zPHcsj78jtoQz1LRAYemeXQ1gAAQYAJT9BfVti1ekAAAAASUVORK5CYII=");
}
.menu a.class-property {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHpSURBVDjLhZNbbxJhEIb3T/RWw78g2fjLvLE2ppe1TYNtvGuNRo6BcA4kIBBOgXCU3QXploCAmNQE/VY55PWbj7CWcPBibuab95l3ZmelZrOJRqOBWq2GarWKSqWCcrmMUqmEYrF4BEA6FFK9XsdyudyKfr8vILlc7iBEos4k6PV6orOu6yaEctwF0un0XohElqmYulGiUCiUptMp5vO5yBMwm80ikUjshEjUdV3IxX+45Z5hGPj29RcykbF463a7SKVSiMfjWxCJOq8tLxYLkPj72MCbEw3nz1WkwytIp9MhF4hEIhsQic/IJpOJKJrNZqKz7aWGm7Mu3l/quDppmxBN08gFAoGACZHy+fwzPiMbj1dFSvVBdL49v8PHq/stiKqq5AJer1dABCWTych8RjYajURRu/EDtmMV7y7+QWzHGj4FV++tVotcwO12H5mzJJNJmc/IhsPhFuSDTcfb0w6uTz/zr7MQLkKhEJxO59ONjfL55FgsxgaDgQm5fKHg+lUbtxdt/Jwaj8UWc4THEY1G5XA4zOgSxeLqD7h5/QW/jbkpdjgcFnOJu44jGAzKfr+f0SWuPzGJeX5DvBdA4fP5rHzTjA5MUZSd4oMACo/HY3W5XIzEdrvdsvOU//e78q5WLn6y7/0viZYv/mL7AwwAAAAASUVORK5CYII=");
}
.menu a.constant {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAAZ9pQ0NQSUNDIFByb2ZpbGUAAHiclZG/SxthGMc/72kJFM3S09aCcIOYDFGCWSIUwWSwokMaBJMMwuXujIHz8nL3auviZmehm3SwLbSLiFNxjIuTuBSKoAjF/gGFlC5FzuFtyaKIDzzw+X7h4fkFRtuW0jeA1UCF5ZmCVanWrMQZvfQDgO1EcrpUmufO+PMdAfBtzJbSP2qljn8Pvd39sjS2ebpzdX53HQB9YaVaA2ECZkNzGjDrml8A5mslFYgSYDortgvCBTLhQrkIYhtINjTvAsm65gMgue40FIg2kA3cZgDiF5B3vcgBIw0oR4YKjPfASKVas/Roag6mhqHnpOvVItj7DE9Hu176GQwswmGu63VeIQAxeBIt5yYAEH0FeHQZx51RSLyD6+04/vsxjq8/Qc8FtANnLVz/dxdhTMJ9Wu+mtf4B6L63s94fgCx8eAmLj2FuC3Z+QGofnnyFUj8sTGLkf/5PfSsAnhdtv1kPbeW5VnmmYBVbfiuMpO149zz6oaG8Nwqg2JIbYbOxoqxpKX0vY80GznjGmshm89wA0tx3Ck/ZLb8AAAAJcEhZcwAACxMAAAsTAQCanBgAAAHMSURBVDiNpVMxb1JhFL0PSOgAeTCYQALiXzBxcmNz07B2IoYwdGrq0IGUgaUDxYXHaElIOqtxUBYZm2BiUhjqVBUb06QJxADv3Xvux+eCxsY+Bj3rOd+5957vXqL/hBNGDIfD58aYMgBS1eNisbh7my4SZqCqZQAHAA5EpBymi4URAMgY80NVCUCYLNyAmaGqxwAIwHWY7q8MBoPBBwD3AVA6nY6QJbr4fLECQCLysVKpPNjYgaq+BsAiQrPZ7KFRQyJyKiKkqu9CZ7kNJycnttvt2k2a0AyIiJh5Y4C/Dfr9/g4z7wE4KpVK3i9SREhEbjyo1Wo7APYAHLVaLS+2rtTeim+R40TavV6vvVwuC9Vq9eufHdTr9bvGmC+5XI5i0Ridjc7aRORFiIhWq1VmOpuSMSti5n1rbdzzvAwzUxAEVK/XM8aYuKruEzl0/umcgiC4Q7TeRGZe+L6/e3X1feK67qHv+6PFYtHMZrOUz+dJVZvMPCoU7h2Ox6PJfD5/eiOD6XTKzPwiGo2+mUwmzUQi8dh13e1UKkXWWnIcZ/vy2yWNx6NX1tpnQRBcJ5NJnyjkmBqNxiMAT0SkuD6m9wBedjqdtxu/5F/wE3qEI6X0xsv2AAAAAElFTkSuQmCC");
}
.menu a.constructor {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHaSURBVDjLlZO7a1NRHMfzfzhIKQ5OHR1ddRRBLA6lg4iTd5PSas37YR56Y2JiHgg21uoFxSatCVFjbl5iNBBiMmUJgWwZhCB4pR9/V4QKfSQdDufF5/v7nu85xwJYprV0Oq0kk8luIpEw4vG48f/eVDiVSikCTobDIePxmGg0yokEBO4OBgNGoxH5fJ5wOHwygVgsZpjVW60WqqqWzbVgMIjf78fn8xlTBcTy736/T7VaJRQKfQoEArqmafR6Pdxu9/ECkUjkglje63Q6NBoNisUihUKBcrlMpVLB6XR2D4df3VQnmRstsWzU63WazSZmX6vV0HWdUqmEw+GY2Gw25SC8dV1l1wrZNX5s3qLdbpPL5fB6vXumZalq2O32rtVqVQ6GuGnCd+HbFnx9AZrC+MkSHo/np8vlmj/M7f4ks6yysyawgB8fwPv70HgKG8v8cp/7fFRO/+AllewqNJ/DhyBsi9A7J1QTkF4E69mXRws8u6ayvSJwRqoG4K2Md+ygxyF5FdbPaMfdlIXUZfiyAUWx/OY25O4JHBP4CtyZ16a9EwuRi1CXs+5K1ew6lB9DXERX517P8tEsPDzfNIP6C5YeQewSrJyeCd4P0bnwXYISy3MCn5oZNtsf3pH46e7XBJcAAAAASUVORK5CYII=");
}
.menu a.event {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAIxSURBVDjLpdNdSFNhGAfww0Cri+gyKLowpMC+LsooEy+SgqJuKqRIiIQKkryoi4zaUmbWSHKdPkYz05xdnKNobmwW6Vi6tbk2TDYl82PTTSr3PXe2s2T+O+dgYwV54S7+vBcvz4/neXleAgCRTf570UXdLda9ORUytW1LDbbkp1TK8h8PLu1rvn92C7houBxfEbA/E+Hn4C6wAQMYTxO8vbkwvMjBYiKED3X7BUQAaFqao6XLgxZyDaxyAp9JArYnBCLjd5CM2bDIupCI6MEEtRjQtWK2rx7t13fzQMUfYHNfx7H4wtQ9xFwPEZuuR+I7jWSgH9H5FrBRI4KeGgTcN6CoKoT3YyMaL+TxwCYBoOi6M5+6i37xgM9YICQ8elnAmKCai4YDJHCPnEDnrUJMdFfxxUg/Ik2JlSPq7anYtAw+0x74zXs54AqYGRLxMN9FK/yem5hySpcMDYfh6hX/DXRR15yhcclS2FEBv+Ugl0OIjFWCmVUgGR9FzE8h6mvGF7MMY21lMJNHecCZBrRUWXhhcrn9ga0IOy4Kxey8BoGZWnwbKsCkbSOGX+cJwFtJEQ9I04C+o5SNTojBuOXc3I8Qn1Nh7v062BUiWHXnWLtD+1TVTxt7anPhfHUayqs7eKAkDajbz3tN5HpYH4swJBfBQq7Fu6aSROZOcAWlLyt3Ch1kzr/iIv0DyHpqirMCvloVJ7MChGJ9w5H0Cq8K6Lx9gAeqVwM8X/6F/Lkh8+43zznRPkqpYfEAAAAASUVORK5CYII=");
}
.menu a.instance-method {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAXFQTFRFwNCxyda8y9i/ucqow9K1tsiku8yrtcejuMqnqb6Ur8OcwtGz/v7+vs6uvM2s3ubWzdnBsMSdla97oLiJ1d/Lm7SDy9i+1uDMlrB81+HO9vj04OjZvMyrmbGB0dzG097JrMGYt8mm3OXUzNnApLuOrcGZpbyP5OveWnBE3+HdvsywpbCbormLPEsuco5Wx9W6ztrCW3FF5+3hwNCy0NzFxNO2praVv8+vq7Wh3+fXWW9Dkax2v8e2tMeiVmVGVWZGi6hvl7F+p72RssWfYHVKgpxpt8ao4unb5enh4ejai6F1uMmn2ePQp72SXm9N6e7kjqN52N/Ryde8sLulgp5mbYhS3+fYfJVjWGdJ/P37+Pr2ZHFYmLJ/eJFgTWA7xdO31t3P9vf18PLu7/Pr3eXV////nbWFZn9N9fb0X3FOiqZvbXhi7e/rhIx8scSe+vv5vc2txNK12eDSl7F/tLquW25Joqmbc4BmV2xCdZBb////Xx6j1gAAAHt0Uk5T//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8Ak8Oo6gAAAPNJREFUeNpiqAIDI2VGTwiLAYilIlONw/hVePKTIQJKLIVRMpLiClJqxTIgAXURf3lvQQEmYWEGd04toIC0ogiTnLwAkxwjQ0F6MEiLDxM3r6qDNSsbO6cbUEuQOYcJC1dAQqCsIitLiKsXA4e6AK+pUFFVlXQahyqbeAWDsxIjG4tOSlUVfwwrpy1jHINTllA8G7eaJb8sO5dCaUQ00FAxZnZmPlFH9jxfUW2QOwyElJkZ9Hn5uJkFGTQsgAJiXJISlXocrFYuEoyhZSB3mBlmJoUz8Pnl2OnmQjznkcgTK6hiz5OhCfUtENiUZ5dAWAABBgDCVz8yTkvDFQAAAABJRU5ErkJggg==");
}
.menu a.instance-property {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAH3SURBVDjLhZNJjxJhEIb7T8xVw78g6fh75mJGY/SqTjRGTXTcbu7xxtItPew2YxMgbGkCNMgSQkgDAiHRKNpkWPL61ZfQGcLioS5V9T711tfVQrVaRaVSQblcRqlUQrFYRKFQgK7ryOfzBwCEfSEYhoHlcrkRvV6PQzKZzF6IQJNJYJomn9zpdGwI5ZgLJJPJnRCBLFMzTaNELpfTJ5MJ5vM5zxMwnU5D07StEIGmrhqZ+JxZNqfTKUY/u4gbMq+1220kEgnEYrENiECTV5YXiwVIPP71Hc9Or+ORdAjNkHit1WqRC0QikTWIwHa0xuMxb5rNZhj+6OLk9Bpef7mN92f38JyBVpBms0kuEAgEbIiQzWavsB2t0WjEm76ZOTyWD/FWvYtP2kN8OLu/Bmk0GuQCPp+PQzgllUqJbEdrOBzypnq3gKe+I7xTj23IiXKEWMnF67VajVxAkqQDe5d4PC6yHa3BYLAB+fj1AV4Fb+KlcgvzxYy7CIVC8Hg8l9delO0nqqpq9ft9G/Lk81W88N/Am+gx/vz9fVHssFe4GNFoVAyHwxZdIrdr6kx8B9Nzyxa73W6H/YjbjiMYDIp+v9+iS1x9YhKz/Jp4J4BCURQne2mLDqxer28V7wVQyLLs9Hq9FoldLpdj6yn/73dlU51MfGlX/R/5GCirExPTUwAAAABJRU5ErkJggg==");
}
.menu a.method {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAAyBpQ0NQSUNDIFByb2ZpbGUAAHicjZRPaBxVHMc/bzqhIIkgrjUGlIeHGCQJayu6RajJJuk2btgu02z+UZDN7NvdMS+z45vZrS1FJCDebPUoXqpFPFQRD5KDgid7KBJore0hCOKpilAs9CJlPcz+mRCL/mDg836/3/v+/gw8GPiqHATakrDpR8bJZeXK6po8eJ0BhhgEKLthMF0sLgCUg0Czz+7/jAC4MVEOAp1fOnn9t5ee+uL9r/O3h78rif35e2zIrKyugZBAqhbzi0BqPeYTQOpMFEQgTgMpt16ugAiAcbPozID4GHi0luD1BFdU6MLAFNBwAxOBlQIyLbcWgbgCpP2K54PYBTKV0N0EawGsv1ZW12TcZpSHY0/DgWt931oIVz6DJ0f7vrFheGIZto/0ffccBCAO7YTVI4cBEINZGPil3b43Cgc/hAcftNt/f9JuP/gUDuzC99ptmlZnR0L8CHG/8Rm2nS49jOOZAMjApROw/Ajk34WPfoXnvoTHv4HiECwexXqH7heptyKAmUZw1ni1eiQPp9Mvy+kg0ErO++7kuCxrLY1Xq0ehNCpUpqUqk2zqptup9xgwqPzSKWAUrLdVONdhsVUpz+aBSRC/V9TsHDAO4vOqd3weGAN2q+Z4KWbxvBfNL8ZsLfm6sNDhYX+9cLKjaQdR1unqh61Tc13/G+XXisAICGejkXeAQ2BNnasvLscs9Ln6TKHDP5mmUwKeBetyoIsLcW/WD6yiUXj4KHwkDjmyTBBgaFDFw0PjkUPhozB4hGz8a6ammGBJjjv43MHg8SZNFBKHJbIFtsZ7CjJ9K/1n+mb6Uvpy+o+LI82xfmTLvO65OxfuUkRherqdaKenWN+lwTQaTQ3FZm+mMNFporuqf3Gkr+TuXLir3ivcT0ypEpUmWEcRsoHBo4VCE6KYTlR72PYU+ur5b4f7tW7a26dvDF49v2dXjX1Tqd5Ue8/9vOR9ZT9jv2DP2xn7KNJ+1Z6yj9mzdsZ+xV7o3Sjh43EGhSGkjMbnLHLP/+vmEr8tAKRyylfGc6WTy8qiaVQ9rRLP3H+E/6f9AwGFFQ3Juvv5AAAACXBIWXMAAAsTAAALEwEAmpwYAAADBklEQVQ4jXVTT0gbeRT+JhPzZ5IQG8WQncTTpLIUYbOXRMSDF4+CV6GXbT304G0v7eIiFFrQk/GYuJd69B7CRkVXtARs9VAXKygoG5z4byCTmd/8fm8mezFS2e47vQfv4+N97/sk/E9tbW294Jw/JyIIIT5MTk6ufG9P+nbY29v7UZKkf/L5vFmr1XRN0/o7nQ42NjauLy4uktlsNmrbtjozM/N3F+PrNru7u2Ui+mJZ1tdqtZrknLuMMTDGEAqFXE3Tkoyxr0T0ZWlpqdzFyffMv8Xj8V8zmYwEIGoYxishxBNFUcA5h67rUSHEK03TnuTzeckwjJ81TaOdnZ2//ADgOI7v/PwcAMAYQzqdVnw+HzjnAIBcLgfGmGLbNk5OTrC+vg7GmO+RBpVK5V1/f/9r27ZBRLi7u8Pp6SkCgQCy2Sx6enrAOYdpmtjf33+/sLDwBgCkWq32SQgxQESRTCbT22q1cH19jc3NzY+2bc+FQiHE4/G3o6OjhU6ng1gshkqlYjiO0yaipp+IfhoeHpZ0Xcft7S0CgQAajQZ8Pt9cqVSqAcDi4iIajcafqqqi2WxifHy8V1XV3vn5+R98nHMwxkBEcF0XXZZ4PP7wXsYYhBDwPA9EBMdx0Gq1YFkWpGKx+KnZbA4kEolIPp/vtSwLwWAQ9Xr9oxBi7h7wdmRkpMA5h+u6WF1dNUzTbAshmg8ilsvld5lM5jURwe/3Q5ZlnJ2dgYgwODgIIoJlWTBNE9Vq9f3a2tqbBx+USqU5zvnv2WwWjuMgGAwiHA4jFoshkUhAUZSHc1RVxcHBwdjQ0JB3dHS07b+/0Uun04hEIqjX6zg+PrZkWVYmJibgeR5WVlYAwBobG1NSqRT6+vpweHjoPfLB7Oxs+ebm5pd2u91MJpO5cDj8eWpqKklEKBaLuuM4Oc/zPluWNSCE+KNer798lIXl5eWXsiw/i0ajT1OplO55nmwYBi4vL+E4jlwoFHS/3//Udd1nXfB/0vhtTU9Pv7i6unrOGIMkSR+2t7e/G+d/AQoXpOKikHZKAAAAAElFTkSuQmCC");
}
.menu a.mixin {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAAZ9pQ0NQSUNDIFByb2ZpbGUAAHiclZG/SxthGMc/72kJFM3S09aCcIOYDFGCWSIUwWSwokMaBJMMwuXujIHz8nL3auviZmehm3SwLbSLiFNxjIuTuBSKoAjF/gGFlC5FzuFtyaKIDzzw+X7h4fkFRtuW0jeA1UCF5ZmCVanWrMQZvfQDgO1EcrpUmufO+PMdAfBtzJbSP2qljn8Pvd39sjS2ebpzdX53HQB9YaVaA2ECZkNzGjDrml8A5mslFYgSYDortgvCBTLhQrkIYhtINjTvAsm65gMgue40FIg2kA3cZgDiF5B3vcgBIw0oR4YKjPfASKVas/Roag6mhqHnpOvVItj7DE9Hu176GQwswmGu63VeIQAxeBIt5yYAEH0FeHQZx51RSLyD6+04/vsxjq8/Qc8FtANnLVz/dxdhTMJ9Wu+mtf4B6L63s94fgCx8eAmLj2FuC3Z+QGofnnyFUj8sTGLkf/5PfSsAnhdtv1kPbeW5VnmmYBVbfiuMpO149zz6oaG8Nwqg2JIbYbOxoqxpKX0vY80GznjGmshm89wA0tx3Ck/ZLb8AAAAJcEhZcwAACxMAAAsTAQCanBgAAAJhSURBVDiNZZPNi85RFMc/9+d5npmwQF4aYUzIzPAMJe9SSNl4+w+wIbKQhQ0rGwtLZqGUhZUslAWRZjBNkiJvWVAUYpRnDGZ+9+WcY3GfGTKnTud263zO95xzrwPYfeLKCovpukED3EbDMAPMyMEmXCUSy+H3D66e6QCoAGiMh3Gus97dztC3H5iNJ0GGKaYw/OM3Y95QqotpWqUZt9a7F7GtZyGL2upYJqCmuarm6nNmTGVqa4XNe4/wP2BmfUU7t568pdEYxVQB0HEVZpgawyOjlD7wr+UWFFepVVi2sp2l82YhAmaKqiFiiCpJjbEycu16/2SAYYgoH4ZGqBVVyrIk+kDSfJ+YQqVaY/a0FtRsMgBARUkS8d6zf93SLD8vAjPjSt8bYmuV//KbCsyIokhMJCm42v8aHxNJDElKwlGt1QgpD3UyQI2UlBAjQcGKFly1CoWhTlFVgjiCTAYUNGXGJKQy4aNQJqGMgo8JnwQfBD86yKeP5+lYfpv69iF2naqf/rsFM5Io0Ud8lNyOGEGUJIqMDTB/3mvWdK1nwaxl9L26waOXD8+uO9o2sxifQUpKDBkQkjIWhRAFn5TRn/dY3bkKKYRVbTsRF9lQ3wSOY0VWoIQkJJ/wUSmjEKNm+V5o/PpK1U1nT9dxAE7uuMSSuT04aJmYgYghQfAxexkT3ishKN9HGrz6PMi5uwcBOHfnIO+GnmPg8zswg6Jg7foezDlEjCSGNqPz+3j0/DaberZw80UvNVdh4Nl9MC46gK0HLlw2OJR/3j/vH4Pmmdb70PIUXMDgF2a9j3u/nPoDgNPEfbFn4CQAAAAASUVORK5CYII=");
}
.menu a.namespace {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAACpUlEQVQ4ET2TS2sTURTHZ+7cySTpI9q0mwgqobsoarGlUBfZCCJKV0Wx+MCvIOK2n6NLcaFk4VIRwYqKoFBX2YVUYppgapKW5jWZuTP+TpQOnLnnnvM///O499qWZdkbGxuqUCg46DqVSslqDYdD0263jejZbNYZDAYT++Hhoel2uyFmUyqVIr21tWWzcQj00un0vDFmLQzDLPt9At8KQRRF17XWZ+M47kxNTX3Bf3B8fOzjijU/hdEFlBmPx98gEBIL0Ht876jCwv8Y/y1sQtZJJpOXgyDoFIvFSDUaDZsAbdv2DYzzkOz6vr9MyXd7vZ7xPM+Q7dFoNLoqCZA5/DfZ64WFBaVzuZzDxnUc5zzsknmXwCZrQAXSq0XfAURN2viOfYVE59DdZrPpSwsaViGYEQKqCdGDer1+QgBGJRKJABzxoSSZocLE7OysqynHIyAJ6xXpnXWPkk+mLBVwSgZcyBB//p/PEroHia/Ieg/nS9jXWH8jXwFF1Wo1lmD5RIc4IkBm0ERW2b/C9VCjrBOwQlkx6wuc+/1+/yR4wsCPs7fou0Hm58hT8MvgfcXA7hO0SWZhfoJcg9TO5/NyPyYfQ7YJsKl2lfUZ2Ba2B+h3FIgBm08EisgMLnCkDsRCMBECbESBKwiGzJ/B7VDpQHMUwfT09BjwHowy4VMAdKvVkqs7OcZMJuNAqrFnWDFbVaXUmOGPNQEG5hBHCEAIUrwD2tV6cXFRLlIsOn27YNISjS4nEh4dHRlVq9XQY0Npf6Q8Sr0EyRw2l7ehyeKKTtwcsiQEfAdg/5FzHSNumlyeDwyph1xEfnBx3pBxU9AUsI2+jupANkB2mEFYLpcjaUhRqsvL8wCdobci62lAvyjxtRBw425jy6N2aPMja51H5lcqleAvPBAtoRoK3h4AAAAASUVORK5CYII=");
}
.menu a.property {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHpSURBVDjLhZNbbxJhEIb3T/RWw78g2fjLvLE2ppe1TYNtvGuNRo6BcA4kIBBOgXCU3QXploCAmNQE/VY55PWbj7CWcPBibuab95l3ZmelZrOJRqOBWq2GarWKSqWCcrmMUqmEYrF4BEA6FFK9XsdyudyKfr8vILlc7iBEos4k6PV6orOu6yaEctwF0un0XohElqmYulGiUCiUptMp5vO5yBMwm80ikUjshEjUdV3IxX+45Z5hGPj29RcykbF463a7SKVSiMfjWxCJOq8tLxYLkPj72MCbEw3nz1WkwytIp9MhF4hEIhsQic/IJpOJKJrNZqKz7aWGm7Mu3l/quDppmxBN08gFAoGACZHy+fwzPiMbj1dFSvVBdL49v8PHq/stiKqq5AJer1dABCWTych8RjYajURRu/EDtmMV7y7+QWzHGj4FV++tVotcwO12H5mzJJNJmc/IhsPhFuSDTcfb0w6uTz/zr7MQLkKhEJxO59ONjfL55FgsxgaDgQm5fKHg+lUbtxdt/Jwaj8UWc4THEY1G5XA4zOgSxeLqD7h5/QW/jbkpdjgcFnOJu44jGAzKfr+f0SWuPzGJeX5DvBdA4fP5rHzTjA5MUZSd4oMACo/HY3W5XIzEdrvdsvOU//e78q5WLn6y7/0viZYv/mL7AwwAAAAASUVORK5CYII=");
}
.menu a.utility {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAIISURBVDjLlZPRT1JxFMf5E+6fwL9Ri8lsI5cSV7swL82w0SZTB6zWXOuB0cLU8HKhuAooTNrFupcAsYWjh1sRIaDgTLGXxmubD2w+9Prth29tXMWH83J+Z5/vOd9zfhoAml7h+mg3ReuhUxIdR37CrVanUXvgvvsOtk4kbJ+kEaos/bkSYCZv0wcri7/zrTS2f32AUOX+2nPWACvd1V4KmM7fnxQP1pE+2kSuJUM+EpFpvUOS5MJVHgQSuBCwWuU72eP3EA8TWCx523NFl+Iv+zrxRgRr+wKeFJ1NVYA9y+o3mjFskbkj9SDGpTGqm2dSJmosZfRYZXPClLxNqQJsGYt2bS+MbEtCF2SVmQCTukOPikaqbxPnik4l3ohC+ilivbGKcC0Af/klXAVHczhuoC8FmDdpyl2YUrjyAlmfHytklATpJronwP9jAYbYIN3XHXTDuDGkJ6qeRzsz7XCNh1AjvshmRRXQnZWVmIQxOfTf5RFV/fw3LyJkC+6d2U5PwOjbEe3Tz4/bQp0/b92WY5VbsZtuQ3SQfpC71+R3/eAqr2ASR7I9AUSVepibUHhSFCVKQv31uXm+0nPwVQ5dgOfLM+jeXNdf6AFRnZz9NNVeKs8jtr+CCDHvRcmL8bSlqQtdo/v+TBaZ+RrcXUaQqLMZy+GVf+OAcGPaWXCckW7OBgTdslrdPxtwvK6n/CCRAAAAAElFTkSuQmCC");
}
.menu ul {
padding: 0;
margin: 0;
list-style: none;
}
.menu ul a {
padding-left: 38px;
background-position: 16px 50%;
}
.menu ul ul a {
padding-left: 48px;
background-position: 26px 50%;
}
.menu ul ul ul a {
padding-left: 58px;
background-position: 36px 50%;
}
.menu ul ul ul ul a {
padding-left: 68px;
background-position: 46px 50%;
}
.docblock {
margin-bottom: 70px;
}
.docblock header {
margin-bottom: 22px;
}
.breadcrumbs {
font-size: 12px;
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
white-space: nowrap;
margin-left: 0;
color: #ccc;
}
.breadcrumbs a {
color: #999;
border: 0;
}
.breadcrumbs a:hover {
text-decoration: underline;
}
.breadcrumbs li {
display: inline;
margin-right: 4px;
}
.breadcrumbs li + li:before {
content: "»";
margin-right: 4px;
}
header > .type {
color: #999;
text-transform: lowercase;
font-weight: bold;
font-style: italic;
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
}
header .name_prefix {
opacity: 0.5;
}
header > .source {
line-height: 1em;
margin-bottom: 5.5px;
}
header > .source a {
font-size: 10px;
color: #ccc;
margin-left: 10px;
text-decoration: none;
border: 0;
}
header > .source a:hover {
text-decoration: underline;
}
.labels span {
border-radius: 3px 3px 3px 3px;
color: #fff;
font-size: 12px;
font-weight: bold;
padding: 2px 5px 3px;
text-transform: lower;
white-space: nowrap;
margin-right: 10px;
}
.labels span.read-only {
background-color: #999;
}
.labels span.internal {
background-color: #999;
}
.labels span.chainable {
background-color: #999;
}
.deprecated-note {
color: #f00;
}
.section {
position: relative;
}
.section h3 {
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
background-position: right 3px;
background-repeat: no-repeat;
display: block;
position: absolute;
left: -145px;
top: 0;
width: 110px;
line-height: 14px;
padding-right: 20px;
padding-top: 4px;
padding-bottom: 4px;
margin: 0;
text-align: right;
font-weight: normal;
font-size: 14px;
color: #888;
}
.section.classes h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHhSURBVDjLpZI9SJVxFMZ/r2YFflw/kcQsiJt5b1ije0tDtbQ3GtFQYwVNFbQ1ujRFa1MUJKQ4VhYqd7K4gopK3UIly+57nnMaXjHjqotnOfDnnOd/nt85SURwkDi02+ODqbsldxUlD0mvHw09ubSXQF1t8512nGJ/Uz/5lnxi0tB+E9QI3D//+EfVqhtppGxUNzCzmf0Ekojg4fS9cBeSoyzHQNuZxNyYXp5ZM5Mk1ZkZT688b6thIBenG/N4OB5B4InciYBCVyGnEBHO+/LH3SFKQuF4OEs/51ndXMXC8Ajqknrcg1O5PGa2h4CJUqVES0OO7sYevv2qoFBmJ/4gF4boaOrg6rPLYWaYiVfDo0my8w5uj12PQleB0vcp5I6HsHAUoqUhR29zH+5B4IxNTvDmxljy3x2YCYUwZVlbzXJh9UKeQY6t2m0Lt94Oh5loPdqK3EkjzZi4MM/Y9Db3MTv/mYWVxaqkw9IOATNR7B5ABHPrZQrtg9sb8XDKa1+QOwsri4zeHD9SAzE1wxBTXz9xtvMc5ZU5lirLSKIz18nJnhOZjb22YKkhd4odg5icpcoyL669TAAujlyIvmPHSWXY1ti1AmZ8mJ3ElP1ips1/YM3H300g+W+51nc95YPEX8fEbdA2ReVYAAAAAElFTkSuQmCC");
line-height: 25px;
background-position: right 8px;
}
.section.class_methods h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAXRQTFRFvLXSuLHQwrzWsKjKxb/YrKTIq6PHr6fKta7OnpS+tKzN/v7+pp3EpZzD2tbmurPRh3uvx8HZzsneopnBjIGx3NnoxL7Y0czgjoO09fT4iHyw0Mvf4d7r0s7hoZjBmI67xsDZy8bcrqbJ3t3hdGmcZ1uQ7evzt7DMysXcqqW7in+xqJ/FtK3Nm5G9lou5nJK99/b6urbHUUlnyMLaTUNvwrzX5OHtgHyMXVhx5uTut6/PubLQ0s/d3tvpNS5LgnmjTkZlTUZmVU1vUklu7Ovv1dLgWU1/fG+o9PT2r6jGY1aObGaAn5uwVk5xkIW129fnvbfT/Pv9TEJsrqfJc2aeRDtgf3WhwLrVi3+ynZW2mo+819Tlp57Ea2CRvbbTin6x7+7yb2OV+fn72dXlTkRw2NTllIm4q6LHfG+mT0Vx29jnZ2J4k4m4mY+8VEp19fX31NDj////npup4+Hpgnas3droXlKIsa661NHfpqG1s6vM////z9cmxgAAAHx0Uk5T////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////AAFq2jEAAADzSURBVHjaYqgGAzMFplIIiwGIJQMLrbP45LmT1CAC0QwMBlWy4nKSuVpVIAEZaUuhYB5BlrQcRltOdaCAqJI0i6KQIIsiE6OOmyZISwELP4ewewlrFRunJ1CLqRW7BgOvvU2FiBIrQ4hKGAO7jCBHnIBrdbWoH7twlXgQg3YqUxWDXnJ1NV8EK2c6UyiDboZAQBV/lD+fCBuvnLORBdBQMWY2Zi6JeLYYfQkfkDuMBRSYGcM5uPiZeRhTKoECYryyUqpe7KwmeVJMZUUgd0Rm+iYkMnI5uTjYmUM8V5zPHcsj78jtoQz1LRAYemeXQ1gAAQYAJT9BfVti1ekAAAAASUVORK5CYII=");
}
.section.class_properties h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHpSURBVDjLhZNbbxJhEIb3T/RWw78g2fjLvLE2ppe1TYNtvGuNRo6BcA4kIBBOgXCU3QXploCAmNQE/VY55PWbj7CWcPBibuab95l3ZmelZrOJRqOBWq2GarWKSqWCcrmMUqmEYrF4BEA6FFK9XsdyudyKfr8vILlc7iBEos4k6PV6orOu6yaEctwF0un0XohElqmYulGiUCiUptMp5vO5yBMwm80ikUjshEjUdV3IxX+45Z5hGPj29RcykbF463a7SKVSiMfjWxCJOq8tLxYLkPj72MCbEw3nz1WkwytIp9MhF4hEIhsQic/IJpOJKJrNZqKz7aWGm7Mu3l/quDppmxBN08gFAoGACZHy+fwzPiMbj1dFSvVBdL49v8PHq/stiKqq5AJer1dABCWTych8RjYajURRu/EDtmMV7y7+QWzHGj4FV++tVotcwO12H5mzJJNJmc/IhsPhFuSDTcfb0w6uTz/zr7MQLkKhEJxO59ONjfL55FgsxgaDgQm5fKHg+lUbtxdt/Jwaj8UWc4THEY1G5XA4zOgSxeLqD7h5/QW/jbkpdjgcFnOJu44jGAzKfr+f0SWuPzGJeX5DvBdA4fP5rHzTjA5MUZSd4oMACo/HY3W5XIzEdrvdsvOU//e78q5WLn6y7/0viZYv/mL7AwwAAAAASUVORK5CYII=");
}
.section.constants h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAAZ9pQ0NQSUNDIFByb2ZpbGUAAHiclZG/SxthGMc/72kJFM3S09aCcIOYDFGCWSIUwWSwokMaBJMMwuXujIHz8nL3auviZmehm3SwLbSLiFNxjIuTuBSKoAjF/gGFlC5FzuFtyaKIDzzw+X7h4fkFRtuW0jeA1UCF5ZmCVanWrMQZvfQDgO1EcrpUmufO+PMdAfBtzJbSP2qljn8Pvd39sjS2ebpzdX53HQB9YaVaA2ECZkNzGjDrml8A5mslFYgSYDortgvCBTLhQrkIYhtINjTvAsm65gMgue40FIg2kA3cZgDiF5B3vcgBIw0oR4YKjPfASKVas/Roag6mhqHnpOvVItj7DE9Hu176GQwswmGu63VeIQAxeBIt5yYAEH0FeHQZx51RSLyD6+04/vsxjq8/Qc8FtANnLVz/dxdhTMJ9Wu+mtf4B6L63s94fgCx8eAmLj2FuC3Z+QGofnnyFUj8sTGLkf/5PfSsAnhdtv1kPbeW5VnmmYBVbfiuMpO149zz6oaG8Nwqg2JIbYbOxoqxpKX0vY80GznjGmshm89wA0tx3Ck/ZLb8AAAAJcEhZcwAACxMAAAsTAQCanBgAAAHMSURBVDiNpVMxb1JhFL0PSOgAeTCYQALiXzBxcmNz07B2IoYwdGrq0IGUgaUDxYXHaElIOqtxUBYZm2BiUhjqVBUb06QJxADv3Xvux+eCxsY+Bj3rOd+5957vXqL/hBNGDIfD58aYMgBS1eNisbh7my4SZqCqZQAHAA5EpBymi4URAMgY80NVCUCYLNyAmaGqxwAIwHWY7q8MBoPBBwD3AVA6nY6QJbr4fLECQCLysVKpPNjYgaq+BsAiQrPZ7KFRQyJyKiKkqu9CZ7kNJycnttvt2k2a0AyIiJh5Y4C/Dfr9/g4z7wE4KpVK3i9SREhEbjyo1Wo7APYAHLVaLS+2rtTeim+R40TavV6vvVwuC9Vq9eufHdTr9bvGmC+5XI5i0Ridjc7aRORFiIhWq1VmOpuSMSti5n1rbdzzvAwzUxAEVK/XM8aYuKruEzl0/umcgiC4Q7TeRGZe+L6/e3X1feK67qHv+6PFYtHMZrOUz+dJVZvMPCoU7h2Ox6PJfD5/eiOD6XTKzPwiGo2+mUwmzUQi8dh13e1UKkXWWnIcZ/vy2yWNx6NX1tpnQRBcJ5NJnyjkmBqNxiMAT0SkuD6m9wBedjqdtxu/5F/wE3qEI6X0xsv2AAAAAElFTkSuQmCC");
}
.section.constructor h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHaSURBVDjLlZO7a1NRHMfzfzhIKQ5OHR1ddRRBLA6lg4iTd5PSas37YR56Y2JiHgg21uoFxSatCVFjbl5iNBBiMmUJgWwZhCB4pR9/V4QKfSQdDufF5/v7nu85xwJYprV0Oq0kk8luIpEw4vG48f/eVDiVSikCTobDIePxmGg0yokEBO4OBgNGoxH5fJ5wOHwygVgsZpjVW60WqqqWzbVgMIjf78fn8xlTBcTy736/T7VaJRQKfQoEArqmafR6Pdxu9/ECkUjkglje63Q6NBoNisUihUKBcrlMpVLB6XR2D4df3VQnmRstsWzU63WazSZmX6vV0HWdUqmEw+GY2Gw25SC8dV1l1wrZNX5s3qLdbpPL5fB6vXumZalq2O32rtVqVQ6GuGnCd+HbFnx9AZrC+MkSHo/np8vlmj/M7f4ks6yysyawgB8fwPv70HgKG8v8cp/7fFRO/+AllewqNJ/DhyBsi9A7J1QTkF4E69mXRws8u6ayvSJwRqoG4K2Md+ygxyF5FdbPaMfdlIXUZfiyAUWx/OY25O4JHBP4CtyZ16a9EwuRi1CXs+5K1ew6lB9DXERX517P8tEsPDzfNIP6C5YeQewSrJyeCd4P0bnwXYISy3MCn5oZNtsf3pH46e7XBJcAAAAASUVORK5CYII=");
}
.section.description h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAKkSURBVDjLpZPdT5JhGMb9W+BPaK3matVqndXWOOigA6fmJ9DUcrUMlrN0mNMsKTUznQpq6pyKAm8CIogmypcg8GIiX8rHRHjhVbPt6o01nMvZWge/k3vP9duuZ/edAyDnf/hjoCMP2Vr3gUDj3CdV6zT1xZ6iFDaKnLEkBFOmPfaZArWT5sw60iFP+BAbOzTcQSqDZzsNRyCNkcVoaGghzDlVQKylOHJrMrUZ2Yf52y6kc36IxpyoH1lHF7EBgyMKV4jCJ5U/1UVscU4IZOYEa3I1HtwI01hwxlDLhDoJD/wxGr5YGmOLAdRIrVCuhmD3JdA6SQabx12srGB0KSpc86ew4olDOGjH4x4z0gdHDD9+c4TaQQtq+k2Yt0egXYugTmoVZgV9cyHSxXTtJjZR3WNCVfcK/NE0ppYDUNu2QTMCtS0IbrsOrVMOWL27eNJtJLOCDoWXdgeTEEosqPxoBK/TwDzWY9rowy51gJ1dGr2zLpS2aVH5QQ+Hbw88sZ7OClrGXbQrkMTTAQu4HXqUv9eh7J0OSfo7tiIU+GItilpUuM/AF2tg98eR36Q+FryQ2kjbVhximQu8dgPKxPMoeTuH4tfqDIWvCBQ2KlDQKEe9dBlGTwR36+THFZg+QoUxAL0jgsoOQzYYS+wjskcjTzSToVAkA7Hqg4Spc6tm4vgT+eIFVvmb+eCSMwLlih/cNg0KmpRoGzdl+BXOb5jAsMYNjSWAm9VjwesPR1knFilPNMu510CkdPZtqK1BvJQsoaRZjqLGaTzv1UNp9EJl9uNqxefU5QdDnFNX+Y5Qxrn9bDLUR6zjqzsMizeWYdG5gy6ZDbk8aehiuYRz5jHdeDTKvlY1IrhSMUxe4g9SuVwpdaFsgDxf2i84V9zH/us1/is/AdevBaK9Tb3EAAAAAElFTkSuQmCC");
}
.section.events h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAIxSURBVDjLpdNdSFNhGAfww0Cri+gyKLowpMC+LsooEy+SgqJuKqRIiIQKkryoi4zaUmbWSHKdPkYz05xdnKNobmwW6Vi6tbk2TDYl82PTTSr3PXe2s2T+O+dgYwV54S7+vBcvz4/neXleAgCRTf570UXdLda9ORUytW1LDbbkp1TK8h8PLu1rvn92C7houBxfEbA/E+Hn4C6wAQMYTxO8vbkwvMjBYiKED3X7BUQAaFqao6XLgxZyDaxyAp9JArYnBCLjd5CM2bDIupCI6MEEtRjQtWK2rx7t13fzQMUfYHNfx7H4wtQ9xFwPEZuuR+I7jWSgH9H5FrBRI4KeGgTcN6CoKoT3YyMaL+TxwCYBoOi6M5+6i37xgM9YICQ8elnAmKCai4YDJHCPnEDnrUJMdFfxxUg/Ik2JlSPq7anYtAw+0x74zXs54AqYGRLxMN9FK/yem5hySpcMDYfh6hX/DXRR15yhcclS2FEBv+Ugl0OIjFWCmVUgGR9FzE8h6mvGF7MMY21lMJNHecCZBrRUWXhhcrn9ga0IOy4Kxey8BoGZWnwbKsCkbSOGX+cJwFtJEQ9I04C+o5SNTojBuOXc3I8Qn1Nh7v062BUiWHXnWLtD+1TVTxt7anPhfHUayqs7eKAkDajbz3tN5HpYH4swJBfBQq7Fu6aSROZOcAWlLyt3Ch1kzr/iIv0DyHpqirMCvloVJ7MChGJ9w5H0Cq8K6Lx9gAeqVwM8X/6F/Lkh8+43zznRPkqpYfEAAAAASUVORK5CYII=");
}
.section.instance_methods h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAXFQTFRFwNCxyda8y9i/ucqow9K1tsiku8yrtcejuMqnqb6Ur8OcwtGz/v7+vs6uvM2s3ubWzdnBsMSdla97oLiJ1d/Lm7SDy9i+1uDMlrB81+HO9vj04OjZvMyrmbGB0dzG097JrMGYt8mm3OXUzNnApLuOrcGZpbyP5OveWnBE3+HdvsywpbCbormLPEsuco5Wx9W6ztrCW3FF5+3hwNCy0NzFxNO2praVv8+vq7Wh3+fXWW9Dkax2v8e2tMeiVmVGVWZGi6hvl7F+p72RssWfYHVKgpxpt8ao4unb5enh4ejai6F1uMmn2ePQp72SXm9N6e7kjqN52N/Ryde8sLulgp5mbYhS3+fYfJVjWGdJ/P37+Pr2ZHFYmLJ/eJFgTWA7xdO31t3P9vf18PLu7/Pr3eXV////nbWFZn9N9fb0X3FOiqZvbXhi7e/rhIx8scSe+vv5vc2txNK12eDSl7F/tLquW25Joqmbc4BmV2xCdZBb////Xx6j1gAAAHt0Uk5T//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8Ak8Oo6gAAAPNJREFUeNpiqAIDI2VGTwiLAYilIlONw/hVePKTIQJKLIVRMpLiClJqxTIgAXURf3lvQQEmYWEGd04toIC0ogiTnLwAkxwjQ0F6MEiLDxM3r6qDNSsbO6cbUEuQOYcJC1dAQqCsIitLiKsXA4e6AK+pUFFVlXQahyqbeAWDsxIjG4tOSlUVfwwrpy1jHINTllA8G7eaJb8sO5dCaUQ00FAxZnZmPlFH9jxfUW2QOwyElJkZ9Hn5uJkFGTQsgAJiXJISlXocrFYuEoyhZSB3mBlmJoUz8Pnl2OnmQjznkcgTK6hiz5OhCfUtENiUZ5dAWAABBgDCVz8yTkvDFQAAAABJRU5ErkJggg==");
}
.section.instance_properties h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAH3SURBVDjLhZNJjxJhEIb7T8xVw78g6fh75mJGY/SqTjRGTXTcbu7xxtItPew2YxMgbGkCNMgSQkgDAiHRKNpkWPL61ZfQGcLioS5V9T711tfVQrVaRaVSQblcRqlUQrFYRKFQgK7ryOfzBwCEfSEYhoHlcrkRvV6PQzKZzF6IQJNJYJomn9zpdGwI5ZgLJJPJnRCBLFMzTaNELpfTJ5MJ5vM5zxMwnU5D07StEIGmrhqZ+JxZNqfTKUY/u4gbMq+1220kEgnEYrENiECTV5YXiwVIPP71Hc9Or+ORdAjNkHit1WqRC0QikTWIwHa0xuMxb5rNZhj+6OLk9Bpef7mN92f38JyBVpBms0kuEAgEbIiQzWavsB2t0WjEm76ZOTyWD/FWvYtP2kN8OLu/Bmk0GuQCPp+PQzgllUqJbEdrOBzypnq3gKe+I7xTj23IiXKEWMnF67VajVxAkqQDe5d4PC6yHa3BYLAB+fj1AV4Fb+KlcgvzxYy7CIVC8Hg8l9delO0nqqpq9ft9G/Lk81W88N/Am+gx/vz9fVHssFe4GNFoVAyHwxZdIrdr6kx8B9Nzyxa73W6H/YjbjiMYDIp+v9+iS1x9YhKz/Jp4J4BCURQne2mLDqxer28V7wVQyLLs9Hq9FoldLpdj6yn/73dlU51MfGlX/R/5GCirExPTUwAAAABJRU5ErkJggg==");
}
.section.mixins h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAAZ9pQ0NQSUNDIFByb2ZpbGUAAHiclZG/SxthGMc/72kJFM3S09aCcIOYDFGCWSIUwWSwokMaBJMMwuXujIHz8nL3auviZmehm3SwLbSLiFNxjIuTuBSKoAjF/gGFlC5FzuFtyaKIDzzw+X7h4fkFRtuW0jeA1UCF5ZmCVanWrMQZvfQDgO1EcrpUmufO+PMdAfBtzJbSP2qljn8Pvd39sjS2ebpzdX53HQB9YaVaA2ECZkNzGjDrml8A5mslFYgSYDortgvCBTLhQrkIYhtINjTvAsm65gMgue40FIg2kA3cZgDiF5B3vcgBIw0oR4YKjPfASKVas/Roag6mhqHnpOvVItj7DE9Hu176GQwswmGu63VeIQAxeBIt5yYAEH0FeHQZx51RSLyD6+04/vsxjq8/Qc8FtANnLVz/dxdhTMJ9Wu+mtf4B6L63s94fgCx8eAmLj2FuC3Z+QGofnnyFUj8sTGLkf/5PfSsAnhdtv1kPbeW5VnmmYBVbfiuMpO149zz6oaG8Nwqg2JIbYbOxoqxpKX0vY80GznjGmshm89wA0tx3Ck/ZLb8AAAAJcEhZcwAACxMAAAsTAQCanBgAAAJhSURBVDiNZZPNi85RFMc/9+d5npmwQF4aYUzIzPAMJe9SSNl4+w+wIbKQhQ0rGwtLZqGUhZUslAWRZjBNkiJvWVAUYpRnDGZ+9+WcY3GfGTKnTud263zO95xzrwPYfeLKCovpukED3EbDMAPMyMEmXCUSy+H3D66e6QCoAGiMh3Gus97dztC3H5iNJ0GGKaYw/OM3Y95QqotpWqUZt9a7F7GtZyGL2upYJqCmuarm6nNmTGVqa4XNe4/wP2BmfUU7t568pdEYxVQB0HEVZpgawyOjlD7wr+UWFFepVVi2sp2l82YhAmaKqiFiiCpJjbEycu16/2SAYYgoH4ZGqBVVyrIk+kDSfJ+YQqVaY/a0FtRsMgBARUkS8d6zf93SLD8vAjPjSt8bYmuV//KbCsyIokhMJCm42v8aHxNJDElKwlGt1QgpD3UyQI2UlBAjQcGKFly1CoWhTlFVgjiCTAYUNGXGJKQy4aNQJqGMgo8JnwQfBD86yKeP5+lYfpv69iF2naqf/rsFM5Io0Ud8lNyOGEGUJIqMDTB/3mvWdK1nwaxl9L26waOXD8+uO9o2sxifQUpKDBkQkjIWhRAFn5TRn/dY3bkKKYRVbTsRF9lQ3wSOY0VWoIQkJJ/wUSmjEKNm+V5o/PpK1U1nT9dxAE7uuMSSuT04aJmYgYghQfAxexkT3ishKN9HGrz6PMi5uwcBOHfnIO+GnmPg8zswg6Jg7foezDlEjCSGNqPz+3j0/DaberZw80UvNVdh4Nl9MC46gK0HLlw2OJR/3j/vH4Pmmdb70PIUXMDgF2a9j3u/nPoDgNPEfbFn4CQAAAAASUVORK5CYII=");
}
.section.namespaces h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAACpUlEQVQ4ET2TS2sTURTHZ+7cySTpI9q0mwgqobsoarGlUBfZCCJKV0Wx+MCvIOK2n6NLcaFk4VIRwYqKoFBX2YVUYppgapKW5jWZuTP+TpQOnLnnnvM///O499qWZdkbGxuqUCg46DqVSslqDYdD0263jejZbNYZDAYT++Hhoel2uyFmUyqVIr21tWWzcQj00un0vDFmLQzDLPt9At8KQRRF17XWZ+M47kxNTX3Bf3B8fOzjijU/hdEFlBmPx98gEBIL0Ht876jCwv8Y/y1sQtZJJpOXgyDoFIvFSDUaDZsAbdv2DYzzkOz6vr9MyXd7vZ7xPM+Q7dFoNLoqCZA5/DfZ64WFBaVzuZzDxnUc5zzsknmXwCZrQAXSq0XfAURN2viOfYVE59DdZrPpSwsaViGYEQKqCdGDer1+QgBGJRKJABzxoSSZocLE7OysqynHIyAJ6xXpnXWPkk+mLBVwSgZcyBB//p/PEroHia/Ieg/nS9jXWH8jXwFF1Wo1lmD5RIc4IkBm0ERW2b/C9VCjrBOwQlkx6wuc+/1+/yR4wsCPs7fou0Hm58hT8MvgfcXA7hO0SWZhfoJcg9TO5/NyPyYfQ7YJsKl2lfUZ2Ba2B+h3FIgBm08EisgMLnCkDsRCMBECbESBKwiGzJ/B7VDpQHMUwfT09BjwHowy4VMAdKvVkqs7OcZMJuNAqrFnWDFbVaXUmOGPNQEG5hBHCEAIUrwD2tV6cXFRLlIsOn27YNISjS4nEh4dHRlVq9XQY0Npf6Q8Sr0EyRw2l7ehyeKKTtwcsiQEfAdg/5FzHSNumlyeDwyph1xEfnBx3pBxU9AUsI2+jupANkB2mEFYLpcjaUhRqsvL8wCdobci62lAvyjxtRBw425jy6N2aPMja51H5lcqleAvPBAtoRoK3h4AAAAASUVORK5CYII=");
line-height: 25px;
background-position: right 8px;
}
.section.subclasses h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAKJSURBVDjLpZLfT1JhGMfduqu7/giv+wsk5mKGB53UBHHiDzjQkQjhmJyT6OiQBhommKJLaVrLZcPWpi3To0KspiSYv8AL160XOVy5uVrz23lPV0225rp49j77Ps/zed5937cIQNH/REFRyHBb3rXb6FhlT+58bJk5E0DIuC8Kaxwmd0cxkRtGW9L+9cw38Ky4jiZyEUQ2gnAtM4v/BPjWedxNt6Ez1Yr2FSe4D46T8WwEY9sDuLVAHza/bTqwztbnTa9r8wUBXmn4+e5jPMuNYCI7jPHsEKLbgxjdGsDw54cYXH+AR5keGGM6FAR0pFg8lYbJ1vspHu73DNgEDWfcLJ1WOJctEqAXhhfXCgMkp+FO2tG14pG3uuI0HMtNuLlYD0asg2XegP6MH/ZZC7TjFCrGyqAeuYJTJjpEC0Y2+mFfakCzaMSNhVqY52vQ+K4ajiUavZ98CKwK8K96oRpSngbY5kwIp3rADJngCwiIRqPgfW40TOphmzWhs7tD1roCXbju1aKkpOSCPCg5DclpcGIL7H4GoVAI+/v72NvbQzweh8ffjs4+D3ZyO7KWTCblHoqiemQAGR6UTGp94gDLuZDe3ISVp0FpKNA0jXA4DJ7n5by8vPyXXq9/QyAsyx7KAHrGiJBkUllLKYR7ggzQRilcLlVAFEWk02kkEgnEYjEoFIrvlZWV5wlAEIRjGdD4yoC+tW7QvQ1g7MwfgFY7p1Qqf6pUKlRVVclBcqKRGgFYrda8DKh7WY2aSS0q+q+iwqBBoC9wMjU1dTA9PY1IJAKnU/qdHCfnRCO1YDCY12g02b9eobi4+Jx0xUtqtfqL2Ww+stlsx1L80Ol0RilKpfwb0UiN9JDe3w8qq6SmnYkEAAAAAElFTkSuQmCC");
}
.section.superclass h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAKJSURBVDjLpZLfT1JhGMfduqu7/giv+wsk5mKGB53UBHHiDzjQkQjhmJyT6OiQBhommKJLaVrLZcPWpi3To0KspiSYv8AL160XOVy5uVrz23lPV0225rp49j77Ps/zed5937cIQNH/REFRyHBb3rXb6FhlT+58bJk5E0DIuC8Kaxwmd0cxkRtGW9L+9cw38Ky4jiZyEUQ2gnAtM4v/BPjWedxNt6Ez1Yr2FSe4D46T8WwEY9sDuLVAHza/bTqwztbnTa9r8wUBXmn4+e5jPMuNYCI7jPHsEKLbgxjdGsDw54cYXH+AR5keGGM6FAR0pFg8lYbJ1vspHu73DNgEDWfcLJ1WOJctEqAXhhfXCgMkp+FO2tG14pG3uuI0HMtNuLlYD0asg2XegP6MH/ZZC7TjFCrGyqAeuYJTJjpEC0Y2+mFfakCzaMSNhVqY52vQ+K4ajiUavZ98CKwK8K96oRpSngbY5kwIp3rADJngCwiIRqPgfW40TOphmzWhs7tD1roCXbju1aKkpOSCPCg5DclpcGIL7H4GoVAI+/v72NvbQzweh8ffjs4+D3ZyO7KWTCblHoqiemQAGR6UTGp94gDLuZDe3ISVp0FpKNA0jXA4DJ7n5by8vPyXXq9/QyAsyx7KAHrGiJBkUllLKYR7ggzQRilcLlVAFEWk02kkEgnEYjEoFIrvlZWV5wlAEIRjGdD4yoC+tW7QvQ1g7MwfgFY7p1Qqf6pUKlRVVclBcqKRGgFYrda8DKh7WY2aSS0q+q+iwqBBoC9wMjU1dTA9PY1IJAKnU/qdHCfnRCO1YDCY12g02b9eobi4+Jx0xUtqtfqL2Ww+stlsx1L80Ol0RilKpfwb0UiN9JDe3w8qq6SmnYkEAAAAAElFTkSuQmCC");
}
.section.utilities h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAIISURBVDjLlZPRT1JxFMf5E+6fwL9Ri8lsI5cSV7swL82w0SZTB6zWXOuB0cLU8HKhuAooTNrFupcAsYWjh1sRIaDgTLGXxmubD2w+9Prth29tXMWH83J+Z5/vOd9zfhoAml7h+mg3ReuhUxIdR37CrVanUXvgvvsOtk4kbJ+kEaos/bkSYCZv0wcri7/zrTS2f32AUOX+2nPWACvd1V4KmM7fnxQP1pE+2kSuJUM+EpFpvUOS5MJVHgQSuBCwWuU72eP3EA8TWCx523NFl+Iv+zrxRgRr+wKeFJ1NVYA9y+o3mjFskbkj9SDGpTGqm2dSJmosZfRYZXPClLxNqQJsGYt2bS+MbEtCF2SVmQCTukOPikaqbxPnik4l3ohC+ilivbGKcC0Af/klXAVHczhuoC8FmDdpyl2YUrjyAlmfHytklATpJronwP9jAYbYIN3XHXTDuDGkJ6qeRzsz7XCNh1AjvshmRRXQnZWVmIQxOfTf5RFV/fw3LyJkC+6d2U5PwOjbEe3Tz4/bQp0/b92WY5VbsZtuQ3SQfpC71+R3/eAqr2ASR7I9AUSVepibUHhSFCVKQv31uXm+0nPwVQ5dgOfLM+jeXNdf6AFRnZz9NNVeKs8jtr+CCDHvRcmL8bSlqQtdo/v+TBaZ+RrcXUaQqLMZy+GVf+OAcGPaWXCckW7OBgTdslrdPxtwvK6n/CCRAAAAAElFTkSuQmCC");
}
.section.sections h3 {
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAAZ9pQ0NQSUNDIFByb2ZpbGUAAHiclZG/SxthGMc/72kJFM3S09aCcIOYDFGCWSIUwWSwokMaBJMMwuXujIHz8nL3auviZmehm3SwLbSLiFNxjIuTuBSKoAjF/gGFlC5FzuFtyaKIDzzw+X7h4fkFRtuW0jeA1UCF5ZmCVanWrMQZvfQDgO1EcrpUmufO+PMdAfBtzJbSP2qljn8Pvd39sjS2ebpzdX53HQB9YaVaA2ECZkNzGjDrml8A5mslFYgSYDortgvCBTLhQrkIYhtINjTvAsm65gMgue40FIg2kA3cZgDiF5B3vcgBIw0oR4YKjPfASKVas/Roag6mhqHnpOvVItj7DE9Hu176GQwswmGu63VeIQAxeBIt5yYAEH0FeHQZx51RSLyD6+04/vsxjq8/Qc8FtANnLVz/dxdhTMJ9Wu+mtf4B6L63s94fgCx8eAmLj2FuC3Z+QGofnnyFUj8sTGLkf/5PfSsAnhdtv1kPbeW5VnmmYBVbfiuMpO149zz6oaG8Nwqg2JIbYbOxoqxpKX0vY80GznjGmshm89wA0tx3Ck/ZLb8AAAAJcEhZcwAACxMAAAsTAQCanBgAAAGpSURBVDiN1ZK/ihRBEMZ/NTtzjMosJ4p4KorZ3qUGZ3LBoU/gC5j4CIKBgab6AoKRYGYmpoIXmItGYqBwKpx74v6/nenp7s9gxt01uVCwkm6q6/vVV0XDfx8G8PHVtfd5d2vLLFl5EtXk89ekGl83n1V/qU7DflrMdnf3fApg6vQu7zxLzQzUiDHDlz+vHrx7+E3WZAE6WVfR1/2N/pu7wIsUQF4l0a1VB08IrgNJF7OC/MINLm4/zpCACIot/NT5Ty93HiwAVpMoOoJbQ1HE+T717AfT/h5ZvgGqITokD3iK3r3MiFcAUgAS8ujnuCOQm1FPxhS92+RnNts1/XEgQFi6DtHSJaBOSE+cY33zzqJQRKL7jh++RmGE/Aj5MQpT8kv3oWzW0gCcpFASjz40xWGC/JBYD1AYgR+2+TEKM1AFNasApOiJ9WHTKYyQH7b3Qdt5vABIHqpVQBVlBOR/tcLh0nYYIT9ZimPZjOlXAHIauOnhyXqyVpgKkzKIBegsClVjMWlOSwJ+Pic6VSsOykdfnt7aVuSmJVYc+3cFsrfOQnx+bN0/i9+QGxia3x5r7AAAAABJRU5ErkJggg==");
line-height: 25px;
background-position: right 8px;
}
.method-list {
margin-left: 0;
list-style: none;
}
.method-list > li {
display: inline-block;
}
.method-list > li:after {
content: ",";
margin: 0 10px 0 2px;
}
.method-list > li:last-child:after {
content: '';
}
.method-list > li > a {
border-bottom: 1px solid #888;
text-decoration: none;
}
.method-details-list {
margin-left: 0;
list-style: none;
}
.method-description > h4 > a {
border-style: none none solid;
}
.section a,
.readme a {
border-style: none none dashed;
}
a.link-short,
.superclass a {
border-style: none none solid;
}
.note {
background-color: #eef;
border: 1px solid #69c;
}
.related-to {
background-color: #fff6de;
border: 1px solid #cc9;
}
.related-to > a {
margin-left: 25px;
}
.alias {
background-color: #fff6de;
border: 1px solid #cc9;
}
.alias > ul {
display: inline;
padding: 0;
}
.alias > ul > li {
display: inline;
}
.alias > ul > li:after {
content: ",";
margin: 0 5px 0 2px;
}
.alias > ul > li:last-child:after {
content: "";
margin: 0;
}
.note,
.related-to,
.alias {
border-radius: 3px;
font-size: 12px;
padding: 5px 30px;
margin-bottom: 11px;
}
.note a,
.related-to a,
.alias a {
border-style: none none solid;
}
.signatures {
background-color: #e0e8e0;
border: 1px solid #ccc;
border-radius: 3px;
padding: 5px 10px;
margin-left: 0;
list-style: none;
}
.signature {
list-style: none;
display: inline;
margin-left: 0;
}
.signature > li {
display: inline;
}
.signature-values {
list-style: none;
display: inline;
margin-left: 0;
}
.signature-values:before {
content: '→';
margin: 0 5px;
}
.signature-values > li {
display: inline;
}
.signature-values > li:after {
content: "|";
margin: 0 2px;
}
.signature-values > li:last-child:after {
content: "";
margin: 0;
}
.argument {
margin-left: 0;
display: inline;
}
.argument > li {
display: inline;
}
.argument-name {
color: #060;
font-weight: bold;
font-size: 13px;
}
.argument-types {
display: inline;
margin-left: 5px;
font-style: italic;
font-size: 11px;
}
.argument-types:before {
content: '(';
margin-right: 2px;
}
.argument-types:after {
content: ')';
margin-left: 2px;
}
.argument-types > li {
display: inline;
}
.argument-types > li:after {
content: "|";
margin: 0 2px;
}
.argument-types > li:last-child:after {
content: "";
margin: 0;
}
.argument-description p {
display: inline;
}
.argument-description:before {
content: '—';
margin-left: 5px;
margin-right: 5px;
}
code {
padding: 2px 4px;
font-size: 90%;
color: #c7254e;
background-color: #f9f2f4;
border-radius: 4px;
}
pre {
border: 1px solid #ccc;
border-radius: 4px;
}
pre code {
padding: 0;
font-size: inherit;
color: inherit;
background-color: transparent;
border-radius: 0;
}
.hljs {
display: block;
overflow-x: auto;
padding: 0.5em;
color: #333;
background: #f8f8f8;
}
.hljs-comment,
.hljs-quote {
color: #998;
font-style: italic;
}
.hljs-keyword,
.hljs-selector-tag,
.hljs-subst {
color: #333;
font-weight: bold;
}
.hljs-number,
.hljs-literal,
.hljs-variable,
.hljs-template-variable,
.hljs-tag .hljs-attr {
color: #008080;
}
.hljs-string,
.hljs-doctag {
color: #d14;
}
.hljs-title,
.hljs-section,
.hljs-selector-id {
color: #900;
font-weight: bold;
}
.hljs-subst {
font-weight: normal;
}
.hljs-type,
.hljs-class .hljs-title {
color: #458;
font-weight: bold;
}
.hljs-tag,
.hljs-name,
.hljs-attribute {
color: #000080;
font-weight: normal;
}
.hljs-regexp,
.hljs-link {
color: #009926;
}
.hljs-symbol,
.hljs-bullet {
color: #990073;
}
.hljs-built_in,
.hljs-builtin-name {
color: #0086b3;
}
.hljs-meta {
color: #999;
font-weight: bold;
}
.hljs-deletion {
background: #fdd;
}
.hljs-addition {
background: #dfd;
}
.hljs-emphasis {
font-style: italic;
}
.hljs-strong {
font-weight: bold;
}
.hljs {
padding: 9.5px;
}
</style><script type="text/javascript">/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */
!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0<t&&t-1 in e)}function fe(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()}ce.fn=ce.prototype={jquery:t,constructor:ce,length:0,toArray:function(){return ae.call(this)},get:function(e){return null==e?ae.call(this):e<0?this[e+this.length]:this[e]},pushStack:function(e){var t=ce.merge(this.constructor(),e);return t.prevObject=this,t},each:function(e){return ce.each(this,e)},map:function(n){return this.pushStack(ce.map(this,function(e,t){return n.call(e,t,e)}))},slice:function(){return this.pushStack(ae.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},even:function(){return this.pushStack(ce.grep(this,function(e,t){return(t+1)%2}))},odd:function(){return this.pushStack(ce.grep(this,function(e,t){return t%2}))},eq:function(e){var t=this.length,n=+e+(e<0?t:0);return this.pushStack(0<=n&&n<t?[this[n]]:[])},end:function(){return this.prevObject||this.constructor()},push:s,sort:oe.sort,splice:oe.splice},ce.extend=ce.fn.extend=function(){var e,t,n,r,i,o,a=arguments[0]||{},s=1,u=arguments.length,l=!1;for("boolean"==typeof a&&(l=a,a=arguments[s]||{},s++),"object"==typeof a||v(a)||(a={}),s===u&&(a=this,s--);s<u;s++)if(null!=(e=arguments[s]))for(t in e)r=e[t],"__proto__"!==t&&a!==r&&(l&&r&&(ce.isPlainObject(r)||(i=Array.isArray(r)))?(n=a[t],o=i&&!Array.isArray(n)?[]:i||ce.isPlainObject(n)?n:{},i=!1,a[t]=ce.extend(l,o,r)):void 0!==r&&(a[t]=r));return a},ce.extend({expando:"jQuery"+(t+Math.random()).replace(/\D/g,""),isReady:!0,error:function(e){throw new Error(e)},noop:function(){},isPlainObject:function(e){var t,n;return!(!e||"[object Object]"!==i.call(e))&&(!(t=r(e))||"function"==typeof(n=ue.call(t,"constructor")&&t.constructor)&&o.call(n)===a)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},globalEval:function(e,t,n){m(e,{nonce:t&&t.nonce},n)},each:function(e,t){var n,r=0;if(c(e)){for(n=e.length;r<n;r++)if(!1===t.call(e[r],r,e[r]))break}else for(r in e)if(!1===t.call(e[r],r,e[r]))break;return e},text:function(e){var t,n="",r=0,i=e.nodeType;if(!i)while(t=e[r++])n+=ce.text(t);return 1===i||11===i?e.textContent:9===i?e.documentElement.textContent:3===i||4===i?e.nodeValue:n},makeArray:function(e,t){var n=t||[];return null!=e&&(c(Object(e))?ce.merge(n,"string"==typeof e?[e]:e):s.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:se.call(t,e,n)},isXMLDoc:function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!l.test(t||n&&n.nodeName||"HTML")},merge:function(e,t){for(var n=+t.length,r=0,i=e.length;r<n;r++)e[i++]=t[r];return e.length=i,e},grep:function(e,t,n){for(var r=[],i=0,o=e.length,a=!n;i<o;i++)!t(e[i],i)!==a&&r.push(e[i]);return r},map:function(e,t,n){var r,i,o=0,a=[];if(c(e))for(r=e.length;o<r;o++)null!=(i=t(e[o],o,n))&&a.push(i);else for(o in e)null!=(i=t(e[o],o,n))&&a.push(i);return g(a)},guid:1,support:le}),"function"==typeof
$(function () {
'use strict';
var $empty = $(), // empty set used upon activtion
$window = $(window),
$items = $('.menu-item > a'),
$results = $('#search-results'), // search results
targets = [], // items and corresponding article offset
$active = null, // active article
baseTitle = document.title; // base (general) part of title
function throttle(func, ms) {
var isThrottled = false,
savedArgs,
savedThis;
function wrapper() {
if (isThrottled) { // (2)
savedArgs = arguments;
savedThis = this;
return;
}
func.apply(this, arguments); // (1)
isThrottled = true;
setTimeout(function() {
isThrottled = false; // (3)
if (savedArgs) {
wrapper.apply(savedThis, savedArgs);
savedArgs = savedThis = null;
}
}, ms);
}
return wrapper;
}
function getTitle($article) {
var title = [baseTitle];
if ($article.data('title')) {
title.push($article.data('title'));
}
return title.join(' | ');
}
function eachParent($item, callback) {
var $parent = $item.data('ndoc.parent');
if ($parent && $parent.length) {
eachParent($parent, callback);
callback($parent);
}
}
// activates item (used upon scrolling)
function activate($article, expandParents) {
var $item;
if ($active) {
$item = $active.data('ndoc.item') || $empty;
$item.removeClass('current');
eachParent($item, function ($parent) {
$parent.removeClass('current-parent');
});
}
// set new active article
$active = $article;
// update title
document.title = getTitle($article);
$item = $active.data('ndoc.item') || $empty;
$item.addClass('current');
eachParent($item, function ($parent) {
$parent.addClass('current-parent');
if (expandParents) {
$parent.data('ndoc.childs')
.data('ndoc.collapsed', false)
.animate({
height: 'show',
opacity: 'show'
});
}
});
}
function processScroll(evt, expandParents) {
var scrollTop = $window.scrollTop() + 10, i = targets.length;
while (i--) {
if ($active !== targets[i].article && scrollTop >= targets[i].offset
&& (!targets[i + 1] || scrollTop <= targets[i + 1].offset)) {
activate(targets[i].article, expandParents);
return;
}
}
}
// init articles
$('article.docblock').each(function () {
var $article = $(this);
targets.push({
article: $article,
offset: $article.offset().top
});
});
// init menu items
$items.each(function () {
var $item = $(this),
$childs = $item.next(),
$parent = $item.parents('ul').eq(0).prev().children(),
$article = $('[id="' + $item.attr('href').slice(1) + '"]');
// cross-refs
$item.data('ndoc.parent', $parent);
$item.data('ndoc.childs', $childs);
$article.data('ndoc.item', $item);
// bind activator
$item.on('click', function () {
if ($item.hasClass('current') && !$childs.data('ndoc.collapsed')) {
$childs.data('ndoc.collapsed', true).animate({
height: 'hide',
opacity: 'hide'
});
return false;
}
activate($article);
$childs.data('ndoc.collapsed', false).animate({
height: 'show',
opacity: 'show'
});
});
// collapse all 2nd levels
if (0 != $parent.length) {
$childs.data('ndoc.collapsed', true).hide();
}
});
function updateSearchResults() {
$results.empty();
if ('' == this.value) {
$results.hide();
return;
}
$results.show();
$items.filter('[data-id*="' + this.value.toLowerCase() + '"]').each(function () {
var $item = $(this);
$('<li class="menu-item">').append(
$item.clone(false)
.text($item.text())
.on('click', function () {
$item.trigger('click');
})
).appendTo($results);
});
}
// init search
$('#search')
// prevent from form submit
.on('submit', function () { return false; })
.find('input')
.on('keyup', throttle(updateSearchResults, 250))
// click - cuz i don't know what event fired on input clear in Chrome
.on('change click', updateSearchResults);
// init scrollspy
$window.on('scroll', throttle(processScroll, 250));
// initial jump (required for FF only - Chrome don't need it)
processScroll(null, true);
});
</script></head><body><div class="gh-ribbon"><a href="https://github.com/markdown-it/markdown-it">Fork me on GitHub</a></div><nav class="sidebar"><form id="search"><input type="search" size="20" title="Search" placeholder="Search"></form><ul class="menu" id="search-results"></ul><ul class="menu"><li class="menu-item"><a href="#Core" class="class internal" title="Core (class)" data-id="core">Core</a><ul><li class="menu-item"><a href="#Core.new" class="constructor" title="new Core (constructor)" data-id="new core">new</a></li><li class="menu-item"><a href="#Core.process" class="class-method" title="Core.process (class method)" data-id="core.process">process</a></li><li class="menu-item"><a href="#Core.prototype.ruler" class="instance-property" title="Core#ruler (instance property)" data-id="core#ruler">ruler</a></li></ul></li><li class="menu-item"><a href="#MarkdownIt" class="class" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a><ul><li class="menu-item"><a href="#MarkdownIt.new" class="constructor" title="new MarkdownIt (constructor)" data-id="new markdownit">new</a></li><li class="menu-item"><a href="#MarkdownIt.configure" class="class-method chainable internal" title="MarkdownIt.configure (class method)" data-id="markdownit.configure">configure</a></li><li class="menu-item"><a href="#MarkdownIt.disable" class="class-method chainable" title="MarkdownIt.disable (class method)" data-id="markdownit.disable">disable</a></li><li class="menu-item"><a href="#MarkdownIt.enable" class="class-method chainable" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">enable</a></li><li class="menu-item"><a href="#MarkdownIt.parse" class="class-method internal" title="MarkdownIt.parse (class method)" data-id="markdownit.parse">parse</a></li><li class="menu-item"><a href="#MarkdownIt.parseInline" class="class-method internal" title="MarkdownIt.parseInline (class method)" data-id="markdownit.parseinline">parseInline</a></li><li class="menu-item"><a href="#MarkdownIt.render" class="class-method" title="MarkdownIt.render (class method)" data-id="markdownit.render">render</a></li><li class="menu-item"><a href="#MarkdownIt.renderInline" class="class-method" title="MarkdownIt.renderInline (class method)" data-id="markdownit.renderinline">renderInline</a></li><li class="menu-item"><a href="#MarkdownIt.set" class="class-method chainable" title="MarkdownIt.set (class method)" data-id="markdownit.set">set</a></li><li class="menu-item"><a href="#MarkdownIt.use" class="class-method chainable" title="MarkdownIt.use (class method)" data-id="markdownit.use">use</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.normalizeLink" class="instance-method" title="MarkdownIt#normalizeLink (instance method)" data-id="markdownit#normalizelink">normalizeLink</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.normalizeLinkText" class="instance-method" title="MarkdownIt#normalizeLinkText (instance method)" data-id="markdownit#normalizelinktext">normalizeLinkText</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.validateLink" class="instance-method" title="MarkdownIt#validateLink (instance method)" data-id="markdownit#validatelink">validateLink</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.block" class="instance-property" title="MarkdownIt#block (instance property)" data-id="markdownit#block">block</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.core" class="instance-property" title="MarkdownIt#core (instance property)" data-id="markdownit#core">core</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.helpers" class="instance-property" title="MarkdownIt#helpers (instance property)" data-id="markdownit#helpers">helpers</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.inline" class="instance-property" title="MarkdownIt#inline (instance property)" data-id="markdownit#inline">inline</a></li><li class="menu-item"><a href="#MarkdownIt.prototype.linkify" class="instance-property" title="MarkdownIt#linkify (instance property)" data-id="markdownit#linkify">linkify<
<h2>Install</h2>
<p><strong>node.js</strong>:</p>
<pre class="hljs language-bash"><code>npm install markdown-it
</code></pre>
<p><strong>browser (CDN):</strong></p>
<ul>
<li><a href="http://www.jsdelivr.com/#!markdown-it" title="jsDelivr CDN">jsDeliver CDN</a></li>
<li><a href="https://cdnjs.com/libraries/markdown-it" title="cdnjs.com">cdnjs.com CDN</a></li>
</ul>
<h2>Usage examples</h2>
<p>See also:</p>
<ul>
<li><a href="https://github.com/markdown-it/markdown-it/tree/master/docs">Development info</a> -
for plugins writers.</li>
</ul>
<h3>Simple</h3>
<pre class="hljs language-js"><code><span class="hljs-comment">// node.js</span>
<span class="hljs-comment">// can use `require(&#x27;markdown-it&#x27;)` for CJS</span>
<span class="hljs-keyword">import</span> markdownit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdown-it&#x27;</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>()
<span class="hljs-keyword">const</span> result = md.<span class="hljs-title function_">render</span>(<span class="hljs-string">&#x27;# markdown-it rulezz!&#x27;</span>);
<span class="hljs-comment">// browser with UMD build, added to &quot;window&quot; on script load</span>
<span class="hljs-comment">// Note, there is no dash in &quot;markdownit&quot;.</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-variable language_">window</span>.<span class="hljs-title function_">markdownit</span>();
<span class="hljs-keyword">const</span> result = md.<span class="hljs-title function_">render</span>(<span class="hljs-string">&#x27;# markdown-it rulezz!&#x27;</span>);
</code></pre>
<p>Single line rendering, without paragraph wrap:</p>
<pre class="hljs language-js"><code><span class="hljs-keyword">import</span> markdownit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdown-it&#x27;</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>()
<span class="hljs-keyword">const</span> result = md.<span class="hljs-title function_">renderInline</span>(<span class="hljs-string">&#x27;__markdown-it__ rulezz!&#x27;</span>);
</code></pre>
<h3>Init with presets and options</h3>
<p>(*) presets define combinations of active rules and options. Can be
<code>&quot;commonmark&quot;</code>, <code>&quot;zero&quot;</code> or <code>&quot;default&quot;</code> (if skipped). See
<a href="https://markdown-it.github.io/markdown-it/#MarkdownIt.new">API docs</a> for more details.</p>
<pre class="hljs language-js"><code><span class="hljs-keyword">import</span> markdownit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdown-it&#x27;</span>
<span class="hljs-comment">// commonmark mode</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>(<span class="hljs-string">&#x27;commonmark&#x27;</span>)
<span class="hljs-comment">// default mode</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>()
<span class="hljs-comment">// enable everything</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>({
<span class="hljs-attr">html</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">linkify</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">typographer</span>: <span class="hljs-literal">true</span>
})
<span class="hljs-comment">// full options list (defaults)</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>({
<span class="hljs-comment">// Enable HTML tags in source</span>
<span class="hljs-attr">html</span>: <span class="hljs-literal">false</span>,
<span class="hljs-comment">// Use &#x27;/&#x27; to close single tags (&lt;br /&gt;).</span>
<span class="hljs-comment">// This is only for full CommonMark compatibility.</span>
<span class="hljs-attr">xhtmlOut</span>: <span class="hljs-literal">false</span>,
<span class="hljs-comment">// Convert &#x27;\n&#x27; in paragraphs into &lt;br&gt;</span>
<span class="hljs-attr">breaks</span>: <span class="hljs-literal">false</span>,
<span class="hljs-comment">// CSS language prefix for fenced blocks. Can be</span>
<span class="hljs-comment">// useful for external highlighters.</span>
<span class="hljs-attr">langPrefix</span>: <span class="hljs-string">&#x27;language-&#x27;</span>,
<span class="hljs-comment">// Autoconvert URL-like text to links</span>
<span class="hljs-attr">linkify</span>: <span class="hljs-literal">false</span>,
<span class="hljs-comment">// Enable some language-neutral replacement + quotes beautification</span>
<span class="hljs-comment">// For the full list of replacements, see https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/replacements.mjs</span>
<span class="hljs-attr">typographer</span>: <span class="hljs-literal">false</span>,
<span class="hljs-comment">// Double + single quotes replacement pairs, when typographer enabled,</span>
<span class="hljs-comment">// and smartquotes on. Could be either a String or an Array.</span>
<span class="hljs-comment">//</span>
<span class="hljs-comment">// For example, you can use &#x27;«»„“&#x27; for Russian, &#x27;„“‚‘&#x27; for German,</span>
<span class="hljs-comment">// and [&#x27;«\xA0&#x27;, &#x27;\xA0»&#x27;, &#x27;‹\xA0&#x27;, &#x27;\xA0›&#x27;] for French (including nbsp).</span>
<span class="hljs-attr">quotes</span>: <span class="hljs-string">&#x27;“”‘’&#x27;</span>,
<span class="hljs-comment">// Highlighter function. Should return escaped HTML,</span>
<span class="hljs-comment">// or &#x27;&#x27; if the source string is not changed and should be escaped externally.</span>
<span class="hljs-comment">// If result starts with &lt;pre... internal wrapper is skipped.</span>
<span class="hljs-attr">highlight</span>: <span class="hljs-keyword">function</span> (<span class="hljs-params"><span class="hljs-comment">/*str, lang*/</span></span>) { <span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&#x27;</span>; }
});
</code></pre>
<h3>Plugins load</h3>
<pre class="hljs language-js"><code><span class="hljs-keyword">import</span> markdownit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdown-it&#x27;</span>
<span class="hljs-keyword">const</span> md = markdownit
.<span class="hljs-title function_">use</span>(plugin1)
.<span class="hljs-title function_">use</span>(plugin2, opts, ...)
.<span class="hljs-title function_">use</span>(plugin3);
</code></pre>
<h3>Syntax highlighting</h3>
<p>Apply syntax highlighting to fenced code blocks with the <code>highlight</code> option:</p>
<pre class="hljs language-js"><code><span class="hljs-keyword">import</span> markdownit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdown-it&#x27;</span>
<span class="hljs-keyword">import</span> hljs <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;highlight.js&#x27;</span> <span class="hljs-comment">// https://highlightjs.org</span>
<span class="hljs-comment">// Actual default values</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>({
<span class="hljs-attr">highlight</span>: <span class="hljs-keyword">function</span> (<span class="hljs-params">str, lang</span>) {
<span class="hljs-keyword">if</span> (lang &amp;&amp; hljs.<span class="hljs-title function_">getLanguage</span>(lang)) {
<span class="hljs-keyword">try</span> {
<span class="hljs-keyword">return</span> hljs.<span class="hljs-title function_">highlight</span>(str, { <span class="hljs-attr">language</span>: lang }).<span class="hljs-property">value</span>;
} <span class="hljs-keyword">catch</span> (__) {}
}
<span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&#x27;</span>; <span class="hljs-comment">// use external default escaping</span>
}
});
</code></pre>
<p>Or with full wrapper override (if you need assign class to <code>&lt;pre&gt;</code> or <code>&lt;code&gt;</code>):</p>
<pre class="hljs language-js"><code><span class="hljs-keyword">import</span> markdownit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdown-it&#x27;</span>
<span class="hljs-keyword">import</span> hljs <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;highlight.js&#x27;</span> <span class="hljs-comment">// https://highlightjs.org</span>
<span class="hljs-comment">// Actual default values</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>({
<span class="hljs-attr">highlight</span>: <span class="hljs-keyword">function</span> (<span class="hljs-params">str, lang</span>) {
<span class="hljs-keyword">if</span> (lang &amp;&amp; hljs.<span class="hljs-title function_">getLanguage</span>(lang)) {
<span class="hljs-keyword">try</span> {
<span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&lt;pre&gt;&lt;code class=&quot;hljs&quot;&gt;&#x27;</span> +
hljs.<span class="hljs-title function_">highlight</span>(str, { <span class="hljs-attr">language</span>: lang, <span class="hljs-attr">ignoreIllegals</span>: <span class="hljs-literal">true</span> }).<span class="hljs-property">value</span> +
<span class="hljs-string">&#x27;&lt;/code&gt;&lt;/pre&gt;&#x27;</span>;
} <span class="hljs-keyword">catch</span> (__) {}
}
<span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&lt;pre&gt;&lt;code class=&quot;hljs&quot;&gt;&#x27;</span> + md.<span class="hljs-property">utils</span>.escapeHtml(str) + <span class="hljs-string">&#x27;&lt;/code&gt;&lt;/pre&gt;&#x27;</span>;
}
});
</code></pre>
<h3>Linkify</h3>
<p><code>linkify: true</code> uses <a href="https://github.com/markdown-it/linkify-it">linkify-it</a>. To
configure linkify-it, access the linkify instance through <code>md.linkify</code>:</p>
<pre class="hljs language-js"><code>md.<span class="hljs-property">linkify</span>.<span class="hljs-title function_">set</span>({ <span class="hljs-attr">fuzzyEmail</span>: <span class="hljs-literal">false</span> }); <span class="hljs-comment">// disables converting email to link</span>
</code></pre>
<h2>Syntax extensions</h2>
<p>Embedded (enabled by default):</p>
<ul>
<li><a href="https://help.github.com/articles/organizing-information-with-tables/">Tables</a> (GFM)</li>
<li><a href="https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text">Strikethrough</a> (GFM)</li>
</ul>
<p>Via plugins:</p>
<ul>
<li><a href="https://github.com/markdown-it/markdown-it-sub">subscript</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-sup">superscript</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-footnote">footnote</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-deflist">definition list</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-abbr">abbreviation</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-emoji">emoji</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-container">custom container</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-ins">insert</a></li>
<li><a href="https://github.com/markdown-it/markdown-it-mark">mark</a></li>
<li>... and <a href="https://www.npmjs.org/browse/keyword/markdown-it-plugin">others</a></li>
</ul>
<h3>Manage rules</h3>
<p>By default all rules are enabled, but can be restricted by options. On plugin
load all its rules are enabled automatically.</p>
<pre class="hljs language-js"><code><span class="hljs-keyword">import</span> markdownit <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;markdown-it&#x27;</span>
<span class="hljs-comment">// Activate/deactivate rules, with currying</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>()
.<span class="hljs-title function_">disable</span>([<span class="hljs-string">&#x27;link&#x27;</span>, <span class="hljs-string">&#x27;image&#x27;</span>])
.<span class="hljs-title function_">enable</span>([<span class="hljs-string">&#x27;link&#x27;</span>])
.<span class="hljs-title function_">enable</span>(<span class="hljs-string">&#x27;image&#x27;</span>);
<span class="hljs-comment">// Enable everything</span>
<span class="hljs-keyword">const</span> md = <span class="hljs-title function_">markdownit</span>({
<span class="hljs-attr">html</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">linkify</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">typographer</span>: <span class="hljs-literal">true</span>,
});
</code></pre>
</div></article><article class="docblock" id="Core" data-title="Core (class)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Core" class="" title="Core (class)" data-id="core">Core</a></li></ul><h2 title="class">Core</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_core.mjs#L7">View source</a></div><div class="labels"><span class="internal">internal</span></div></header><div class="section description"><h3>Description</h3><div class="content"><p>Top-level rules executor. Glues block/inline parsers and does intermediate
transformations.</p>
</div></div><div class="section constructor"><h3>Constructor</h3><div class="content"></div><ul class="method-list"><li><a href="#Core.new" class="" title="new Core (constructor)" data-id="new core">new Core</a></li></ul></div><div class="section class_methods"><h3>Class methods</h3><div class="content"><ul class="method-list"><li><a href="#Core.process" class="" title="Core.process (class method)" data-id="core.process">process</a></li></ul></div></div><div class="section instance_properties"><h3>Instance properties</h3><div class="content"><ul class="method-list"><li><a href="#Core.prototype.ruler" class="" title="Core#ruler (instance property)" data-id="core#ruler">ruler</a></li></ul></div></div></article><article class="docblock" id="Core.new" data-title="new Core (constructor)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Core" class="" title="Core (class)" data-id="core">Core</a></li><li><a href="#Core.new" class="" title="new Core (constructor)" data-id="new core">new</a></li></ul><h2 title="constructor"><span class="name_prefix">Core.</span>new</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_core.mjs#L34">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">new Core()</li></ul></li></ul></div></div></article><article class="docblock" id="Core.process" data-title="Core.process (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Core" class="" title="Core (class)" data-id="core">Core</a></li><li><a href="#Core.process" class="" title="Core.process (class method)" data-id="core.process">process</a></li></ul><h2 title="class method"><span class="name_prefix">Core.</span>process</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_core.mjs#L52">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Core.process(state)</li></ul></li></ul><p>Executes core chain rules.</p>
</div></div></article><article class="docblock" id="Core.prototype.ruler" data-title="Core#ruler (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Core" class="" title="Core (class)" data-id="core">Core</a></li><li><a href="#Core.prototype.ruler" class="" title="Core#ruler (instance property)" data-id="core#ruler">ruler</a></li></ul><h2 title="instance property"><span class="name_prefix">Core#</span>ruler</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_core.mjs#L40">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Core#ruler</li><li><ul class="signature-values"><li><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a></li></ul></li></ul></li></ul><p><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a> instance. Keep configuration of core rules.</p>
</div></div></article><article class="docblock" id="MarkdownIt" data-title="MarkdownIt (class)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li></ul><h2 title="class">MarkdownIt</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L114">View source</a></div></header><div class="section description"><h3>Description</h3><div class="content"><p>Main parser/renderer class.</p>
<h5>Usage</h5>
<pre class="hljs language-javascript"><code><span class="hljs-comment">// node.js, &quot;classic&quot; way:</span>
<span class="hljs-keyword">var</span> <span class="hljs-title class_">MarkdownIt</span> = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>),
md = <span class="hljs-keyword">new</span> <span class="hljs-title class_">MarkdownIt</span>();
<span class="hljs-keyword">var</span> result = md.<span class="hljs-title function_">render</span>(<span class="hljs-string">&#x27;# markdown-it rulezz!&#x27;</span>);
<span class="hljs-comment">// node.js, the same, but with sugar:</span>
<span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
<span class="hljs-keyword">var</span> result = md.<span class="hljs-title function_">render</span>(<span class="hljs-string">&#x27;# markdown-it rulezz!&#x27;</span>);
<span class="hljs-comment">// browser without AMD, added to &quot;window&quot; on script load</span>
<span class="hljs-comment">// Note, there are no dash.</span>
<span class="hljs-keyword">var</span> md = <span class="hljs-variable language_">window</span>.<span class="hljs-title function_">markdownit</span>();
<span class="hljs-keyword">var</span> result = md.<span class="hljs-title function_">render</span>(<span class="hljs-string">&#x27;# markdown-it rulezz!&#x27;</span>);
</code></pre>
<p>Single line rendering, without paragraph wrap:</p>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
<span class="hljs-keyword">var</span> result = md.<span class="hljs-title function_">renderInline</span>(<span class="hljs-string">&#x27;__markdown-it__ rulezz!&#x27;</span>);
</code></pre>
</div></div><div class="section constructor"><h3>Constructor</h3><div class="content"></div><ul class="method-list"><li><a href="#MarkdownIt.new" class="" title="new MarkdownIt (constructor)" data-id="new markdownit">new MarkdownIt</a></li></ul></div><div class="section class_methods"><h3>Class methods</h3><div class="content"><ul class="method-list"><li><a href="#MarkdownIt.configure" class="" title="MarkdownIt.configure (class method)" data-id="markdownit.configure">configure</a></li><li><a href="#MarkdownIt.disable" class="" title="MarkdownIt.disable (class method)" data-id="markdownit.disable">disable</a></li><li><a href="#MarkdownIt.enable" class="" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">enable</a></li><li><a href="#MarkdownIt.parse" class="" title="MarkdownIt.parse (class method)" data-id="markdownit.parse">parse</a></li><li><a href="#MarkdownIt.parseInline" class="" title="MarkdownIt.parseInline (class method)" data-id="markdownit.parseinline">parseInline</a></li><li><a href="#MarkdownIt.render" class="" title="MarkdownIt.render (class method)" data-id="markdownit.render">render</a></li><li><a href="#MarkdownIt.renderInline" class="" title="MarkdownIt.renderInline (class method)" data-id="markdownit.renderinline">renderInline</a></li><li><a href="#MarkdownIt.set" class="" title="MarkdownIt.set (class method)" data-id="markdownit.set">set</a></li><li><a href="#MarkdownIt.use" class="" title="MarkdownIt.use (class method)" data-id="markdownit.use">use</a></li></ul></div></div><div class="section instance_methods"><h3>Instance methods</h3><div class="content"><ul class="method-list"><li><a href="#MarkdownIt.prototype.normalizeLink" class="" title="MarkdownIt#normalizeLink (instance method)" data-id="markdownit#normalizelink">normalizeLink</a></li><li><a href="#MarkdownIt.prototype.normalizeLinkText" class="" title="MarkdownIt#normalizeLinkText (instance method)" data-id="markdownit#normalizelinktext">normalizeLinkText</a></li><li><a href="#MarkdownIt.prototype.validateLink" class="" title="MarkdownIt#validateLink (instance method)" data-id="markdownit#validatelink">validateLink</a></li></ul></div></div><div class="section instance_properties"><h3>Instance properties</h3><div class="content"><ul class="method-list"><li><a href="#MarkdownIt.prototype.block" class="" title="MarkdownIt#block (instance property)" data-id="markdownit#block">block</a></li><li><a href="#MarkdownIt.prototype.core" class="" title="MarkdownIt#core (instance property)" data-id="markdownit#core">core</a></li><li><a href="#MarkdownIt.prototype.helpers" class="" title="MarkdownIt#helpers (instance property)" data-id="markdownit#helpers">helpers</a></li><li><a href="#MarkdownIt.prototype.inline" class="" title="MarkdownIt#inline (instance property)" data-id="markdownit#inline">inline</a></li><li><a href="#MarkdownIt.prototype.linkify" class="" title="MarkdownIt#linkify (instance property)" data-id="markdownit#linkify">linkify</a></li><li><a href="#MarkdownIt.prototype.renderer" class="" title="MarkdownIt#renderer (instance property)" data-id="markdownit#renderer">renderer</a></li><li><a href="#MarkdownIt.prototype.utils" class="" title="MarkdownIt#utils (instance property)" data-id="markdownit#utils">utils</a></li></ul></div></div></article><article class="docblock" id="MarkdownIt.new" data-title="new MarkdownIt (constructor)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.new" class="" title="new MarkdownIt (constructor)" data-id="new markdownit">new</a></li></ul><h2 title="constructor"><span class="name_prefix">MarkdownIt.</span>new</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L217">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">new MarkdownIt([presetName][, options])</li></ul></li></ul><ul class="arguments"><li>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li></ul></li></ul><p>Creates parser instanse with given config. Can be called without <code>new</code>.</p>
<h5>presetName</h5>
<p>MarkdownIt provides named presets as a convenience to quickly
enable/disable active syntax rules and options for common use cases.</p>
<ul>
<li><a href="https://github.com/markdown-it/markdown-it/blob/master/lib/presets/commonmark.mjs">&quot;commonmark&quot;</a> -
configures parser to strict <a href="http://commonmark.org/">CommonMark</a> mode.</li>
<li><a href="https://github.com/markdown-it/markdown-it/blob/master/lib/presets/default.mjs">default</a> -
similar to GFM, used when no preset name given. Enables all available rules,
but still without html, typographer &amp; autolinker.</li>
<li><a href="https://github.com/markdown-it/markdown-it/blob/master/lib/presets/zero.mjs">&quot;zero&quot;</a> -
all rules disabled. Useful to quickly setup your config via <code>.enable()</code>.
For example, when you need only <code>bold</code> and <code>italic</code> markup and nothing else.</li>
</ul>
<h5>options:</h5>
<ul>
<li><strong>html</strong> - <code>false</code>. Set <code>true</code> to enable HTML tags in source. Be careful!
That's not safe! You may need external sanitizer to protect output from XSS.
It's better to extend features via plugins, instead of enabling HTML.</li>
<li><strong>xhtmlOut</strong> - <code>false</code>. Set <code>true</code> to add '/' when closing single tags
(<code>&lt;br /&gt;</code>). This is needed only for full CommonMark compatibility. In real
world you will need HTML output.</li>
<li><strong>breaks</strong> - <code>false</code>. Set <code>true</code> to convert <code>\n</code> in paragraphs into <code>&lt;br&gt;</code>.</li>
<li><strong>langPrefix</strong> - <code>language-</code>. CSS language class prefix for fenced blocks.
Can be useful for external highlighters.</li>
<li><strong>linkify</strong> - <code>false</code>. Set <code>true</code> to autoconvert URL-like text to links.</li>
<li><strong>typographer</strong> - <code>false</code>. Set <code>true</code> to enable <a href="https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/replacements.mjs">some language-neutral
replacement</a> +
quotes beautification (smartquotes).</li>
<li><strong>quotes</strong> - <code>“”‘’</code>, String or Array. Double + single quotes replacement
pairs, when typographer enabled and smartquotes on. For example, you can
use <code>'«»„“'</code> for Russian, <code>'„“‚‘'</code> for German, and
<code>['«\xA0', '\xA0»', '‹\xA0', '\xA0›']</code> for French (including nbsp).</li>
<li><strong>highlight</strong> - <code>null</code>. Highlighter function for fenced code blocks.
Highlighter <code>function (str, lang)</code> should return escaped HTML. It can also
return empty string if the source was not changed and should be escaped
externaly. If result starts with &lt;pre... internal wrapper is skipped.</li>
</ul>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-comment">// commonmark mode</span>
<span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)(<span class="hljs-string">&#x27;commonmark&#x27;</span>);
<span class="hljs-comment">// default mode</span>
<span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
<span class="hljs-comment">// enable everything</span>
<span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)({
<span class="hljs-attr">html</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">linkify</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">typographer</span>: <span class="hljs-literal">true</span>
});
</code></pre>
<h5>Syntax highlighting</h5>
<pre class="hljs language-js"><code><span class="hljs-keyword">var</span> hljs = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;highlight.js&#x27;</span>) <span class="hljs-comment">// https://highlightjs.org/</span>
<span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)({
<span class="hljs-attr">highlight</span>: <span class="hljs-keyword">function</span> (<span class="hljs-params">str, lang</span>) {
<span class="hljs-keyword">if</span> (lang &amp;&amp; hljs.<span class="hljs-title function_">getLanguage</span>(lang)) {
<span class="hljs-keyword">try</span> {
<span class="hljs-keyword">return</span> hljs.<span class="hljs-title function_">highlight</span>(str, { <span class="hljs-attr">language</span>: lang, <span class="hljs-attr">ignoreIllegals</span>: <span class="hljs-literal">true</span> }).<span class="hljs-property">value</span>;
} <span class="hljs-keyword">catch</span> (__) {}
}
<span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&#x27;</span>; <span class="hljs-comment">// use external default escaping</span>
}
});
</code></pre>
<p>Or with full wrapper override (if you need assign class to <code>&lt;pre&gt;</code> or <code>&lt;code&gt;</code>):</p>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> hljs = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;highlight.js&#x27;</span>) <span class="hljs-comment">// https://highlightjs.org/</span>
<span class="hljs-comment">// Actual default values</span>
<span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)({
<span class="hljs-attr">highlight</span>: <span class="hljs-keyword">function</span> (<span class="hljs-params">str, lang</span>) {
<span class="hljs-keyword">if</span> (lang &amp;&amp; hljs.<span class="hljs-title function_">getLanguage</span>(lang)) {
<span class="hljs-keyword">try</span> {
<span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&lt;pre&gt;&lt;code class=&quot;hljs&quot;&gt;&#x27;</span> +
hljs.<span class="hljs-title function_">highlight</span>(str, { <span class="hljs-attr">language</span>: lang, <span class="hljs-attr">ignoreIllegals</span>: <span class="hljs-literal">true</span> }).<span class="hljs-property">value</span> +
<span class="hljs-string">&#x27;&lt;/code&gt;&lt;/pre&gt;&#x27;</span>;
} <span class="hljs-keyword">catch</span> (__) {}
}
<span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&lt;pre&gt;&lt;code class=&quot;hljs&quot;&gt;&#x27;</span> + md.<span class="hljs-property">utils</span>.escapeHtml(str) + <span class="hljs-string">&#x27;&lt;/code&gt;&lt;/pre&gt;&#x27;</span>;
}
});
</code></pre>
</div></div></article><article class="docblock" id="MarkdownIt.configure" data-title="MarkdownIt.configure (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.configure" class="" title="MarkdownIt.configure (class method)" data-id="markdownit.configure">configure</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>configure</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L378">View source</a></div><div class="labels"><span class="chainable">chainable</span><span class="internal">internal</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.configure(presets)</li></ul></li></ul><p>Batch load of all options and compenent settings. This is internal method,
and you probably will not need it. But if you will - see available presets
and data structure <a href="https://github.com/markdown-it/markdown-it/tree/master/lib/presets">here</a></p>
<p>We strongly recommend to use presets instead of direct config loads. That
will give better compatibility with next versions.</p>
</div></div></article><article class="docblock" id="MarkdownIt.disable" data-title="MarkdownIt.disable (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.disable" class="" title="MarkdownIt.disable (class method)" data-id="markdownit.disable">disable</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>disable</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L448">View source</a></div><div class="labels"><span class="chainable">chainable</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.disable(list, ignoreInvalid)</li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">list</li><li><ul class="argument-types"><li class="argument-type">String</li><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>rule name or list of rule names to disable.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">ignoreInvalid</li><li><ul class="argument-types"><li class="argument-type">Boolean</li></ul></li><li class="argument-description"><p>set <code>true</code> to ignore errors when rule not found.</p>
</li></ul></li></ul><p>The same as <a href="#MarkdownIt.enable" class="link-short" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">MarkdownIt.enable</a>, but turn specified rules off.</p>
</div></div></article><article class="docblock" id="MarkdownIt.enable" data-title="MarkdownIt.enable (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.enable" class="" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">enable</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>enable</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L421">View source</a></div><div class="labels"><span class="chainable">chainable</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.enable(list, ignoreInvalid)</li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">list</li><li><ul class="argument-types"><li class="argument-type">String</li><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>rule name or list of rule names to enable</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">ignoreInvalid</li><li><ul class="argument-types"><li class="argument-type">Boolean</li></ul></li><li class="argument-description"><p>set <code>true</code> to ignore errors when rule not found.</p>
</li></ul></li></ul><p>Enable list or rules. It will automatically find appropriate components,
containing rules with given names. If rule not found, and <code>ignoreInvalid</code>
not set - throws exception.</p>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)()
.<span class="hljs-title function_">enable</span>([<span class="hljs-string">&#x27;sub&#x27;</span>, <span class="hljs-string">&#x27;sup&#x27;</span>])
.<span class="hljs-title function_">disable</span>(<span class="hljs-string">&#x27;smartquotes&#x27;</span>);
</code></pre>
</div></div></article><article class="docblock" id="MarkdownIt.parse" data-title="MarkdownIt.parse (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.parse" class="" title="MarkdownIt.parse (class method)" data-id="markdownit.parse">parse</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>parse</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L504">View source</a></div><div class="labels"><span class="internal">internal</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.parse(src, env)</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">src</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>source string</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">env</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>environment sandbox</p>
</li></ul></li></ul><p>Parse input string and return list of block tokens (special token type
&quot;inline&quot; will contain list of inline tokens). You should not call this
method directly, until you write custom renderer (for example, to produce
AST).</p>
<p><code>env</code> is used to pass data between &quot;distributed&quot; rules and return additional
metadata like reference info, needed for the renderer. It also can be used to
inject data in specific cases. Usually, you will be ok to pass <code>{}</code>,
and then pass updated object to renderer.</p>
</div></div></article><article class="docblock" id="MarkdownIt.parseInline" data-title="MarkdownIt.parseInline (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.parseInline" class="" title="MarkdownIt.parseInline (class method)" data-id="markdownit.parseinline">parseInline</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>parseInline</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L542">View source</a></div><div class="labels"><span class="internal">internal</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.parseInline(src, env)</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">src</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>source string</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">env</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>environment sandbox</p>
</li></ul></li></ul><p>The same as <a href="#MarkdownIt.parse" class="link-short" title="MarkdownIt.parse (class method)" data-id="markdownit.parse">MarkdownIt.parse</a> but skip all block rules. It returns the
block tokens list with the single <code>inline</code> element, containing parsed inline
tokens in <code>children</code> property. Also updates <code>env</code> object.</p>
</div></div></article><article class="docblock" id="MarkdownIt.render" data-title="MarkdownIt.render (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.render" class="" title="MarkdownIt.render (class method)" data-id="markdownit.render">render</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>render</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L527">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.render(src[, env])</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">src</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>source string</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">env</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>environment sandbox</p>
</li></ul></li></ul><p>Render markdown string into html. It does all magic for you :).</p>
<p><code>env</code> can be used to inject additional metadata (<code>{}</code> by default).
But you will not need it with high probability. See also comment
in <a href="#MarkdownIt.parse" class="link-short" title="MarkdownIt.parse (class method)" data-id="markdownit.parse">MarkdownIt.parse</a>.</p>
</div></div></article><article class="docblock" id="MarkdownIt.renderInline" data-title="MarkdownIt.renderInline (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.renderInline" class="" title="MarkdownIt.renderInline (class method)" data-id="markdownit.renderinline">renderInline</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>renderInline</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L559">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.renderInline(src[, env])</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">src</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>source string</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">env</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>environment sandbox</p>
</li></ul></li></ul><p>Similar to <a href="#MarkdownIt.render" class="link-short" title="MarkdownIt.render (class method)" data-id="markdownit.render">MarkdownIt.render</a> but for single paragraph content. Result
will NOT be wrapped into <code>&lt;p&gt;</code> tags.</p>
</div></div></article><article class="docblock" id="MarkdownIt.set" data-title="MarkdownIt.set (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.set" class="" title="MarkdownIt.set (class method)" data-id="markdownit.set">set</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>set</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L363">View source</a></div><div class="labels"><span class="chainable">chainable</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.set(options)</li></ul></li></ul><p>Set parser options (in the same format as in constructor). Probably, you
will never need it, but you can change options after constructor call.</p>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)()
.<span class="hljs-title function_">set</span>({ <span class="hljs-attr">html</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">breaks</span>: <span class="hljs-literal">true</span> })
.<span class="hljs-title function_">set</span>({ typographer, <span class="hljs-literal">true</span> });
</code></pre>
<p><strong>Note:</strong> To achieve the best possible performance, don't modify a
<code>markdown-it</code> instance options on the fly. If you need multiple configurations
it's best to create multiple instances and initialize each with separate
config.</p>
</div></div></article><article class="docblock" id="MarkdownIt.use" data-title="MarkdownIt.use (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.use" class="" title="MarkdownIt.use (class method)" data-id="markdownit.use">use</a></li></ul><h2 title="class method"><span class="name_prefix">MarkdownIt.</span>use</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L483">View source</a></div><div class="labels"><span class="chainable">chainable</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt.use(plugin, params)</li></ul></li></ul><p>Load specified plugin with given params into current parser instance.
It's just a sugar to call <code>plugin(md, params)</code> with curring.</p>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> iterator = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it-for-inline&#x27;</span>);
<span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)()
.<span class="hljs-title function_">use</span>(iterator, <span class="hljs-string">&#x27;foo_replace&#x27;</span>, <span class="hljs-string">&#x27;text&#x27;</span>, <span class="hljs-keyword">function</span> (<span class="hljs-params">tokens, idx</span>) {
tokens[idx].<span class="hljs-property">content</span> = tokens[idx].<span class="hljs-property">content</span>.<span class="hljs-title function_">replace</span>(<span class="hljs-regexp">/foo/g</span>, <span class="hljs-string">&#x27;bar&#x27;</span>);
});
</code></pre>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.normalizeLink" data-title="MarkdownIt#normalizeLink (instance method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.normalizeLink" class="" title="MarkdownIt#normalizeLink (instance method)" data-id="markdownit#normalizelink">normalizeLink</a></li></ul><h2 title="instance method"><span class="name_prefix">MarkdownIt#</span>normalizeLink</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L311">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#normalizeLink(url)</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>Function used to encode link url to a machine-readable format,
which includes url-encoding, punycode, etc.</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.normalizeLinkText" data-title="MarkdownIt#normalizeLinkText (instance method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.normalizeLinkText" class="" title="MarkdownIt#normalizeLinkText (instance method)" data-id="markdownit#normalizelinktext">normalizeLinkText</a></li></ul><h2 title="instance method"><span class="name_prefix">MarkdownIt#</span>normalizeLinkText</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L318">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#normalizeLinkText(url)</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>Function used to decode link url to a human-readable format`</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.validateLink" data-title="MarkdownIt#validateLink (instance method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.validateLink" class="" title="MarkdownIt#validateLink (instance method)" data-id="markdownit#validatelink">validateLink</a></li></ul><h2 title="instance method"><span class="name_prefix">MarkdownIt#</span>validateLink</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L303">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#validateLink(url)</li><li><ul class="signature-values"><li>Boolean</li></ul></li></ul></li></ul><p>Link validation function. CommonMark allows too much in links. By default
we disable <code>javascript:</code>, <code>vbscript:</code>, <code>file:</code> schemas, and almost all <code>data:...</code> schemas
except some embedded image types.</p>
<p>You can change this behaviour:</p>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
<span class="hljs-comment">// enable everything</span>
md.<span class="hljs-property">validateLink</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) { <span class="hljs-keyword">return</span> <span class="hljs-literal">true</span>; }
</code></pre>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.block" data-title="MarkdownIt#block (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.block" class="" title="MarkdownIt#block (instance property)" data-id="markdownit#block">block</a></li></ul><h2 title="instance property"><span class="name_prefix">MarkdownIt#</span>block</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L245">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#block</li><li><ul class="signature-values"><li><a href="#ParserBlock" class="link-short" title="ParserBlock (class)" data-id="parserblock">ParserBlock</a></li></ul></li></ul></li></ul><p>Instance of <a href="#ParserBlock" class="link-short" title="ParserBlock (class)" data-id="parserblock">ParserBlock</a>. You may need it to add new rules when
writing plugins. For simple rules control use <a href="#MarkdownIt.disable" class="link-short" title="MarkdownIt.disable (class method)" data-id="markdownit.disable">MarkdownIt.disable</a> and
<a href="#MarkdownIt.enable" class="link-short" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">MarkdownIt.enable</a>.</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.core" data-title="MarkdownIt#core (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.core" class="" title="MarkdownIt#core (instance property)" data-id="markdownit#core">core</a></li></ul><h2 title="instance property"><span class="name_prefix">MarkdownIt#</span>core</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L254">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#core</li><li><ul class="signature-values"><li><a href="#Core" class="link-short" title="Core (class)" data-id="core">Core</a></li></ul></li></ul></li></ul><p>Instance of <a href="#Core" class="link-short" title="Core (class)" data-id="core">Core</a> chain executor. You may need it to add new rules when
writing plugins. For simple rules control use <a href="#MarkdownIt.disable" class="link-short" title="MarkdownIt.disable (class method)" data-id="markdownit.disable">MarkdownIt.disable</a> and
<a href="#MarkdownIt.enable" class="link-short" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">MarkdownIt.enable</a>.</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.helpers" data-title="MarkdownIt#helpers (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.helpers" class="" title="MarkdownIt#helpers (instance property)" data-id="markdownit#helpers">helpers</a></li></ul><h2 title="instance property"><span class="name_prefix">MarkdownIt#</span>helpers</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L336">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#helpers</li><li><ul class="signature-values"><li>helpers</li></ul></li></ul></li></ul><p>Link components parser functions, useful to write plugins. See details
<a href="https://github.com/markdown-it/markdown-it/blob/master/lib/helpers">here</a>.</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.inline" data-title="MarkdownIt#inline (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.inline" class="" title="MarkdownIt#inline (instance property)" data-id="markdownit#inline">inline</a></li></ul><h2 title="instance property"><span class="name_prefix">MarkdownIt#</span>inline</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L236">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#inline</li><li><ul class="signature-values"><li><a href="#ParserInline" class="link-short" title="ParserInline (class)" data-id="parserinline">ParserInline</a></li></ul></li></ul></li></ul><p>Instance of <a href="#ParserInline" class="link-short" title="ParserInline (class)" data-id="parserinline">ParserInline</a>. You may need it to add new rules when
writing plugins. For simple rules control use <a href="#MarkdownIt.disable" class="link-short" title="MarkdownIt.disable (class method)" data-id="markdownit.disable">MarkdownIt.disable</a> and
<a href="#MarkdownIt.enable" class="link-short" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">MarkdownIt.enable</a>.</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.linkify" data-title="MarkdownIt#linkify (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.linkify" class="" title="MarkdownIt#linkify (instance property)" data-id="markdownit#linkify">linkify</a></li></ul><h2 title="instance property"><span class="name_prefix">MarkdownIt#</span>linkify</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L286">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#linkify</li><li><ul class="signature-values"><li>LinkifyIt</li></ul></li></ul></li></ul><p><a href="https://github.com/markdown-it/linkify-it">linkify-it</a> instance.
Used by <a href="https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/linkify.mjs">linkify</a>
rule.</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.renderer" data-title="MarkdownIt#renderer (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.renderer" class="" title="MarkdownIt#renderer (instance property)" data-id="markdownit#renderer">renderer</a></li></ul><h2 title="instance property"><span class="name_prefix">MarkdownIt#</span>renderer</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L277">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#renderer</li><li><ul class="signature-values"><li><a href="#Renderer" class="link-short" title="Renderer (class)" data-id="renderer">Renderer</a></li></ul></li></ul></li></ul><p>Instance of <a href="#Renderer" class="link-short" title="Renderer (class)" data-id="renderer">Renderer</a>. Use it to modify output look. Or to add rendering
rules for new token types, generated by plugins.</p>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
<span class="hljs-keyword">function</span> <span class="hljs-title function_">myToken</span>(<span class="hljs-params">tokens, idx, options, env, self</span>) {
<span class="hljs-comment">//...</span>
<span class="hljs-keyword">return</span> result;
};
md.<span class="hljs-property">renderer</span>.<span class="hljs-property">rules</span>[<span class="hljs-string">&#x27;my_token&#x27;</span>] = myToken
</code></pre>
<p>See <a href="#Renderer" class="link-short" title="Renderer (class)" data-id="renderer">Renderer</a> docs and <a href="https://github.com/markdown-it/markdown-it/blob/master/lib/renderer.mjs">source code</a>.</p>
</div></div></article><article class="docblock" id="MarkdownIt.prototype.utils" data-title="MarkdownIt#utils (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#MarkdownIt" class="" title="MarkdownIt (class)" data-id="markdownit">MarkdownIt</a></li><li><a href="#MarkdownIt.prototype.utils" class="" title="MarkdownIt#utils (instance property)" data-id="markdownit#utils">utils</a></li></ul><h2 title="instance property"><span class="name_prefix">MarkdownIt#</span>utils</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/index.mjs#L328">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">MarkdownIt#utils</li><li><ul class="signature-values"><li>utils</li></ul></li></ul></li></ul><p>Assorted utility functions, useful to write plugins. See details
<a href="https://github.com/markdown-it/markdown-it/blob/master/lib/common/utils.mjs">here</a>.</p>
</div></div></article><article class="docblock" id="ParserBlock" data-title="ParserBlock (class)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserBlock" class="" title="ParserBlock (class)" data-id="parserblock">ParserBlock</a></li></ul><h2 title="class">ParserBlock</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_block.mjs#L6">View source</a></div><div class="labels"><span class="internal">internal</span></div></header><div class="section description"><h3>Description</h3><div class="content"><p>Block-level tokenizer.</p>
</div></div><div class="section constructor"><h3>Constructor</h3><div class="content"></div><ul class="method-list"><li><a href="#ParserBlock.new" class="" title="new ParserBlock (constructor)" data-id="new parserblock">new ParserBlock</a></li></ul></div><div class="section class_methods"><h3>Class methods</h3><div class="content"><ul class="method-list"><li><a href="#ParserBlock.parse" class="" title="ParserBlock.parse (class method)" data-id="parserblock.parse">parse</a></li></ul></div></div><div class="section instance_properties"><h3>Instance properties</h3><div class="content"><ul class="method-list"><li><a href="#ParserBlock.prototype.ruler" class="" title="ParserBlock#ruler (instance property)" data-id="parserblock#ruler">ruler</a></li></ul></div></div></article><article class="docblock" id="ParserBlock.new" data-title="new ParserBlock (constructor)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserBlock" class="" title="ParserBlock (class)" data-id="parserblock">ParserBlock</a></li><li><a href="#ParserBlock.new" class="" title="new ParserBlock (constructor)" data-id="new parserblock">new</a></li></ul><h2 title="constructor"><span class="name_prefix">ParserBlock.</span>new</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_block.mjs#L41">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">new ParserBlock()</li></ul></li></ul></div></div></article><article class="docblock" id="ParserBlock.parse" data-title="ParserBlock.parse (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserBlock" class="" title="ParserBlock (class)" data-id="parserblock">ParserBlock</a></li><li><a href="#ParserBlock.parse" class="" title="ParserBlock.parse (class method)" data-id="parserblock.parse">parse</a></li></ul><h2 title="class method"><span class="name_prefix">ParserBlock.</span>parse</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_block.mjs#L124">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">ParserBlock.parse(str, md, env, outTokens)</li></ul></li></ul><p>Process input string and push block tokens into <code>outTokens</code></p>
</div></div></article><article class="docblock" id="ParserBlock.prototype.ruler" data-title="ParserBlock#ruler (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserBlock" class="" title="ParserBlock (class)" data-id="parserblock">ParserBlock</a></li><li><a href="#ParserBlock.prototype.ruler" class="" title="ParserBlock#ruler (instance property)" data-id="parserblock#ruler">ruler</a></li></ul><h2 title="instance property"><span class="name_prefix">ParserBlock#</span>ruler</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_block.mjs#L47">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">ParserBlock#ruler</li><li><ul class="signature-values"><li><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a></li></ul></li></ul></li></ul><p><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a> instance. Keep configuration of block rules.</p>
</div></div></article><article class="docblock" id="ParserInline" data-title="ParserInline (class)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserInline" class="" title="ParserInline (class)" data-id="parserinline">ParserInline</a></li></ul><h2 title="class">ParserInline</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_inline.mjs#L6">View source</a></div><div class="labels"><span class="internal">internal</span></div></header><div class="section description"><h3>Description</h3><div class="content"><p>Tokenizes paragraph content.</p>
</div></div><div class="section constructor"><h3>Constructor</h3><div class="content"></div><ul class="method-list"><li><a href="#ParserInline.new" class="" title="new ParserInline (constructor)" data-id="new parserinline">new ParserInline</a></li></ul></div><div class="section class_methods"><h3>Class methods</h3><div class="content"><ul class="method-list"><li><a href="#ParserInline.parse" class="" title="ParserInline.parse (class method)" data-id="parserinline.parse">parse</a></li></ul></div></div><div class="section instance_properties"><h3>Instance properties</h3><div class="content"><ul class="method-list"><li><a href="#ParserInline.prototype.ruler" class="" title="ParserInline#ruler (instance property)" data-id="parserinline#ruler">ruler</a></li><li><a href="#ParserInline.prototype.ruler2" class="" title="ParserInline#ruler2 (instance property)" data-id="parserinline#ruler2">ruler2</a></li></ul></div></div></article><article class="docblock" id="ParserInline.new" data-title="new ParserInline (constructor)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserInline" class="" title="ParserInline (class)" data-id="parserinline">ParserInline</a></li><li><a href="#ParserInline.new" class="" title="new ParserInline (constructor)" data-id="new parserinline">new</a></li></ul><h2 title="constructor"><span class="name_prefix">ParserInline.</span>new</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_inline.mjs#L60">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">new ParserInline()</li></ul></li></ul></div></div></article><article class="docblock" id="ParserInline.parse" data-title="ParserInline.parse (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserInline" class="" title="ParserInline (class)" data-id="parserinline">ParserInline</a></li><li><a href="#ParserInline.parse" class="" title="ParserInline.parse (class method)" data-id="parserinline.parse">parse</a></li></ul><h2 title="class method"><span class="name_prefix">ParserInline.</span>parse</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_inline.mjs#L182">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">ParserInline.parse(str, md, env, outTokens)</li></ul></li></ul><p>Process input string and push inline tokens into <code>outTokens</code></p>
</div></div></article><article class="docblock" id="ParserInline.prototype.ruler" data-title="ParserInline#ruler (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserInline" class="" title="ParserInline (class)" data-id="parserinline">ParserInline</a></li><li><a href="#ParserInline.prototype.ruler" class="" title="ParserInline#ruler (instance property)" data-id="parserinline#ruler">ruler</a></li></ul><h2 title="instance property"><span class="name_prefix">ParserInline#</span>ruler</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_inline.mjs#L66">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">ParserInline#ruler</li><li><ul class="signature-values"><li><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a></li></ul></li></ul></li></ul><p><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a> instance. Keep configuration of inline rules.</p>
</div></div></article><article class="docblock" id="ParserInline.prototype.ruler2" data-title="ParserInline#ruler2 (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#ParserInline" class="" title="ParserInline (class)" data-id="parserinline">ParserInline</a></li><li><a href="#ParserInline.prototype.ruler2" class="" title="ParserInline#ruler2 (instance property)" data-id="parserinline#ruler2">ruler2</a></li></ul><h2 title="instance property"><span class="name_prefix">ParserInline#</span>ruler2</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/parser_inline.mjs#L78">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">ParserInline#ruler2</li><li><ul class="signature-values"><li><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a></li></ul></li></ul></li></ul><p><a href="#Ruler" class="link-short" title="Ruler (class)" data-id="ruler">Ruler</a> instance. Second ruler used for post-processing
(e.g. in emphasis-like rules).</p>
</div></div></article><article class="docblock" id="Renderer" data-title="Renderer (class)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li></ul><h2 title="class">Renderer</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L8">View source</a></div></header><div class="section description"><h3>Description</h3><div class="content"><p>Generates HTML from parsed token stream. Each instance has independent
copy of rules. Those can be rewritten with ease. Also, you can add new
rules if you create plugin and adds new token types.</p>
</div></div><div class="section constructor"><h3>Constructor</h3><div class="content"></div><ul class="method-list"><li><a href="#Renderer.new" class="" title="new Renderer (constructor)" data-id="new renderer">new Renderer</a></li></ul></div><div class="section class_methods"><h3>Class methods</h3><div class="content"><ul class="method-list"><li><a href="#Renderer.render" class="" title="Renderer.render (class method)" data-id="renderer.render">render</a></li><li><a href="#Renderer.renderAttrs" class="" title="Renderer.renderAttrs (class method)" data-id="renderer.renderattrs">renderAttrs</a></li><li><a href="#Renderer.renderInline" class="" title="Renderer.renderInline (class method)" data-id="renderer.renderinline">renderInline</a></li><li><a href="#Renderer.renderInlineAsText" class="" title="Renderer.renderInlineAsText (class method)" data-id="renderer.renderinlineastext">renderInlineAsText</a></li><li><a href="#Renderer.renderToken" class="" title="Renderer.renderToken (class method)" data-id="renderer.rendertoken">renderToken</a></li></ul></div></div><div class="section instance_properties"><h3>Instance properties</h3><div class="content"><ul class="method-list"><li><a href="#Renderer.prototype.rules" class="" title="Renderer#rules (instance property)" data-id="renderer#rules">rules</a></li></ul></div></div></article><article class="docblock" id="Renderer.new" data-title="new Renderer (constructor)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li><li><a href="#Renderer.new" class="" title="new Renderer (constructor)" data-id="new renderer">new</a></li></ul><h2 title="constructor"><span class="name_prefix">Renderer.</span>new</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L114">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">new Renderer()</li></ul></li></ul><p>Creates new <a href="#Renderer" class="link-short" title="Renderer (class)" data-id="renderer">Renderer</a> instance and fill <a href="#Renderer.prototype.rules" class="link-short" title="Renderer#rules (instance property)" data-id="renderer#rules">Renderer#rules</a> with defaults.</p>
</div></div></article><article class="docblock" id="Renderer.render" data-title="Renderer.render (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li><li><a href="#Renderer.render" class="" title="Renderer.render (class method)" data-id="renderer.render">render</a></li></ul><h2 title="class method"><span class="name_prefix">Renderer.</span>render</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L303">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Renderer.render(tokens, options, env)</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">tokens</li><li><ul class="argument-types"><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>list on block tokens to render</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>params of parser instance</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">env</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>additional data from parsed input (references, for example)</p>
</li></ul></li></ul><p>Takes token stream and generates HTML. Probably, you will never need to call
this method directly.</p>
</div></div></article><article class="docblock" id="Renderer.renderAttrs" data-title="Renderer.renderAttrs (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li><li><a href="#Renderer.renderAttrs" class="" title="Renderer.renderAttrs (class method)" data-id="renderer.renderattrs">renderAttrs</a></li></ul><h2 title="class method"><span class="name_prefix">Renderer.</span>renderAttrs</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L151">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Renderer.renderAttrs(token)</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>Render token attributes to string.</p>
</div></div></article><article class="docblock" id="Renderer.renderInline" data-title="Renderer.renderInline (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li><li><a href="#Renderer.renderInline" class="" title="Renderer.renderInline (class method)" data-id="renderer.renderinline">renderInline</a></li></ul><h2 title="class method"><span class="name_prefix">Renderer.</span>renderInline</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L240">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Renderer.renderInline(tokens, options, env)</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">tokens</li><li><ul class="argument-types"><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>list on block tokens to render</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>params of parser instance</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">env</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>additional data from parsed input (references, for example)</p>
</li></ul></li></ul><p>The same as <a href="#Renderer.render" class="link-short" title="Renderer.render (class method)" data-id="renderer.render">Renderer.render</a>, but for single token of <code>inline</code> type.</p>
</div></div></article><article class="docblock" id="Renderer.renderInlineAsText" data-title="Renderer.renderInlineAsText (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li><li><a href="#Renderer.renderInlineAsText" class="" title="Renderer.renderInlineAsText (class method)" data-id="renderer.renderinlineastext">renderInlineAsText</a></li></ul><h2 title="class method"><span class="name_prefix">Renderer.</span>renderInlineAsText</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L267">View source</a></div><div class="labels"><span class="internal">internal</span></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Renderer.renderInlineAsText(tokens, options, env)</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">tokens</li><li><ul class="argument-types"><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>list on block tokens to render</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>params of parser instance</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">env</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>additional data from parsed input (references, for example)</p>
</li></ul></li></ul><p>Special kludge for image <code>alt</code> attributes to conform CommonMark spec.
Don't try to use it! Spec requires to show <code>alt</code> content with stripped markup,
instead of simple escaping.</p>
</div></div></article><article class="docblock" id="Renderer.renderToken" data-title="Renderer.renderToken (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li><li><a href="#Renderer.renderToken" class="" title="Renderer.renderToken (class method)" data-id="renderer.rendertoken">renderToken</a></li></ul><h2 title="class method"><span class="name_prefix">Renderer.</span>renderToken</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L174">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Renderer.renderToken(tokens, idx, options)</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">tokens</li><li><ul class="argument-types"><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>list of tokens</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">idx</li><li><ul class="argument-types"><li class="argument-type">Numbed</li></ul></li><li class="argument-description"><p>token index to render</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>params of parser instance</p>
</li></ul></li></ul><p>Default token renderer. Can be overriden by custom function
in <a href="#Renderer.prototype.rules" class="link-short" title="Renderer#rules (instance property)" data-id="renderer#rules">Renderer#rules</a>.</p>
</div></div></article><article class="docblock" id="Renderer.prototype.rules" data-title="Renderer#rules (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Renderer" class="" title="Renderer (class)" data-id="renderer">Renderer</a></li><li><a href="#Renderer.prototype.rules" class="" title="Renderer#rules (instance property)" data-id="renderer#rules">rules</a></li></ul><h2 title="instance property"><span class="name_prefix">Renderer#</span>rules</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/renderer.mjs#L143">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Renderer#rules</li><li><ul class="signature-values"><li>Object</li></ul></li></ul></li></ul><p>Contains render rules for tokens. Can be updated and extended.</p>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
md.<span class="hljs-property">renderer</span>.<span class="hljs-property">rules</span>.<span class="hljs-property">strong_open</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) { <span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&lt;b&gt;&#x27;</span>; };
md.<span class="hljs-property">renderer</span>.<span class="hljs-property">rules</span>.<span class="hljs-property">strong_close</span> = <span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) { <span class="hljs-keyword">return</span> <span class="hljs-string">&#x27;&lt;/b&gt;&#x27;</span>; };
<span class="hljs-keyword">var</span> result = md.<span class="hljs-title function_">renderInline</span>(...);
</code></pre>
<p>Each rule is called as independent static function with fixed signature:</p>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">function</span> <span class="hljs-title function_">my_token_render</span>(<span class="hljs-params">tokens, idx, options, env, renderer</span>) {
<span class="hljs-comment">// ...</span>
<span class="hljs-keyword">return</span> renderedHTML;
}
</code></pre>
<p>See <a href="https://github.com/markdown-it/markdown-it/blob/master/lib/renderer.mjs">source code</a>
for more details and examples.</p>
</div></div></article><article class="docblock" id="Ruler" data-title="Ruler (class)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li></ul><h2 title="class">Ruler</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L18">View source</a></div></header><div class="section description"><h3>Description</h3><div class="content"><p>Helper class, used by <a href="#MarkdownIt.prototype.core" class="link-short" title="MarkdownIt#core (instance property)" data-id="markdownit#core">MarkdownIt#core</a>, <a href="#MarkdownIt.prototype.block" class="link-short" title="MarkdownIt#block (instance property)" data-id="markdownit#block">MarkdownIt#block</a> and
<a href="#MarkdownIt.prototype.inline" class="link-short" title="MarkdownIt#inline (instance property)" data-id="markdownit#inline">MarkdownIt#inline</a> to manage sequences of functions (rules):</p>
<ul>
<li>keep rules in defined order</li>
<li>assign the name to each rule</li>
<li>enable/disable rules</li>
<li>add/replace rules</li>
<li>allow assign rules to additional named chains (in the same)</li>
<li>cacheing lists of active rules</li>
</ul>
<p>You will not need use this class directly until write plugins. For simple
rules control use <a href="#MarkdownIt.disable" class="link-short" title="MarkdownIt.disable (class method)" data-id="markdownit.disable">MarkdownIt.disable</a>, <a href="#MarkdownIt.enable" class="link-short" title="MarkdownIt.enable (class method)" data-id="markdownit.enable">MarkdownIt.enable</a> and
<a href="#MarkdownIt.use" class="link-short" title="MarkdownIt.use (class method)" data-id="markdownit.use">MarkdownIt.use</a>.</p>
</div></div><div class="section constructor"><h3>Constructor</h3><div class="content"></div><ul class="method-list"><li><a href="#Ruler.new" class="" title="new Ruler (constructor)" data-id="new ruler">new Ruler</a></li></ul></div><div class="section class_methods"><h3>Class methods</h3><div class="content"><ul class="method-list"><li><a href="#Ruler.after" class="" title="Ruler.after (class method)" data-id="ruler.after">after</a></li><li><a href="#Ruler.at" class="" title="Ruler.at (class method)" data-id="ruler.at">at</a></li><li><a href="#Ruler.before" class="" title="Ruler.before (class method)" data-id="ruler.before">before</a></li><li><a href="#Ruler.disable" class="" title="Ruler.disable (class method)" data-id="ruler.disable">disable</a></li><li><a href="#Ruler.enable" class="" title="Ruler.enable (class method)" data-id="ruler.enable">enable</a></li><li><a href="#Ruler.enableOnly" class="" title="Ruler.enableOnly (class method)" data-id="ruler.enableonly">enableOnly</a></li><li><a href="#Ruler.getRules" class="" title="Ruler.getRules (class method)" data-id="ruler.getrules">getRules</a></li><li><a href="#Ruler.push" class="" title="Ruler.push (class method)" data-id="ruler.push">push</a></li></ul></div></div></article><article class="docblock" id="Ruler.new" data-title="new Ruler (constructor)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.new" class="" title="new Ruler (constructor)" data-id="new ruler">new</a></li></ul><h2 title="constructor"><span class="name_prefix">Ruler.</span>new</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L22">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">new Ruler()</li></ul></li></ul></div></div></article><article class="docblock" id="Ruler.after" data-title="Ruler.after (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.after" class="" title="Ruler.after (class method)" data-id="ruler.after">after</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>after</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L186">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.after(afterName, ruleName, fn[, options])</li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">afterName</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>new rule will be added after this one.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">ruleName</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>name of added rule.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">fn</li><li><ul class="argument-types"><li class="argument-type">Function</li></ul></li><li class="argument-description"><p>rule function.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>rule options (not mandatory).</p>
</li></ul></li></ul><p>Add new rule to chain after one with given name. See also
<a href="#Ruler.before" class="link-short" title="Ruler.before (class method)" data-id="ruler.before">Ruler.before</a>, <a href="#Ruler.push" class="link-short" title="Ruler.push (class method)" data-id="ruler.push">Ruler.push</a>.</p>
<h5>Options:</h5>
<ul>
<li><strong>alt</strong> - array with names of &quot;alternate&quot; chains.</li>
</ul>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
md.<span class="hljs-property">inline</span>.<span class="hljs-property">ruler</span>.<span class="hljs-title function_">after</span>(<span class="hljs-string">&#x27;text&#x27;</span>, <span class="hljs-string">&#x27;my_rule&#x27;</span>, <span class="hljs-keyword">function</span> <span class="hljs-title function_">replace</span>(<span class="hljs-params">state</span>) {
<span class="hljs-comment">//...</span>
});
</code></pre>
</div></div></article><article class="docblock" id="Ruler.at" data-title="Ruler.at (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.at" class="" title="Ruler.at (class method)" data-id="ruler.at">at</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>at</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L111">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.at(name, fn[, options])</li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">name</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>rule name to replace.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">fn</li><li><ul class="argument-types"><li class="argument-type">Function</li></ul></li><li class="argument-description"><p>new rule function.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>new rule options (not mandatory).</p>
</li></ul></li></ul><p>Replace rule by name with new function &amp; options. Throws error if name not
found.</p>
<h5>Options:</h5>
<ul>
<li><strong>alt</strong> - array with names of &quot;alternate&quot; chains.</li>
</ul>
<h5>Example</h5>
<p>Replace existing typographer replacement rule with new one:</p>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
md.<span class="hljs-property">core</span>.<span class="hljs-property">ruler</span>.<span class="hljs-title function_">at</span>(<span class="hljs-string">&#x27;replacements&#x27;</span>, <span class="hljs-keyword">function</span> <span class="hljs-title function_">replace</span>(<span class="hljs-params">state</span>) {
<span class="hljs-comment">//...</span>
});
</code></pre>
</div></div></article><article class="docblock" id="Ruler.before" data-title="Ruler.before (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.before" class="" title="Ruler.before (class method)" data-id="ruler.before">before</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>before</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L146">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.before(beforeName, ruleName, fn[, options])</li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">beforeName</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>new rule will be added before this one.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">ruleName</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>name of added rule.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">fn</li><li><ul class="argument-types"><li class="argument-type">Function</li></ul></li><li class="argument-description"><p>rule function.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>rule options (not mandatory).</p>
</li></ul></li></ul><p>Add new rule to chain before one with given name. See also
<a href="#Ruler.after" class="link-short" title="Ruler.after (class method)" data-id="ruler.after">Ruler.after</a>, <a href="#Ruler.push" class="link-short" title="Ruler.push (class method)" data-id="ruler.push">Ruler.push</a>.</p>
<h5>Options:</h5>
<ul>
<li><strong>alt</strong> - array with names of &quot;alternate&quot; chains.</li>
</ul>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
md.<span class="hljs-property">block</span>.<span class="hljs-property">ruler</span>.<span class="hljs-title function_">before</span>(<span class="hljs-string">&#x27;paragraph&#x27;</span>, <span class="hljs-string">&#x27;my_rule&#x27;</span>, <span class="hljs-keyword">function</span> <span class="hljs-title function_">replace</span>(<span class="hljs-params">state</span>) {
<span class="hljs-comment">//...</span>
});
</code></pre>
</div></div></article><article class="docblock" id="Ruler.disable" data-title="Ruler.disable (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.disable" class="" title="Ruler.disable (class method)" data-id="ruler.disable">disable</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>disable</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L301">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.disable(list[, ignoreInvalid])</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">list</li><li><ul class="argument-types"><li class="argument-type">String</li><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>list of rule names to disable.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">ignoreInvalid</li><li><ul class="argument-types"><li class="argument-type">Boolean</li></ul></li><li class="argument-description"><p>set <code>true</code> to ignore errors when rule not found.</p>
</li></ul></li></ul><p>Disable rules with given names. If any rule name not found - throw Error.
Errors can be disabled by second param.</p>
<p>Returns list of found rule names (if no exception happened).</p>
<p>See also <a href="#Ruler.enable" class="link-short" title="Ruler.enable (class method)" data-id="ruler.enable">Ruler.enable</a>, <a href="#Ruler.enableOnly" class="link-short" title="Ruler.enableOnly (class method)" data-id="ruler.enableonly">Ruler.enableOnly</a>.</p>
</div></div></article><article class="docblock" id="Ruler.enable" data-title="Ruler.enable (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.enable" class="" title="Ruler.enable (class method)" data-id="ruler.enable">enable</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>enable</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L250">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.enable(list[, ignoreInvalid])</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">list</li><li><ul class="argument-types"><li class="argument-type">String</li><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>list of rule names to enable.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">ignoreInvalid</li><li><ul class="argument-types"><li class="argument-type">Boolean</li></ul></li><li class="argument-description"><p>set <code>true</code> to ignore errors when rule not found.</p>
</li></ul></li></ul><p>Enable rules with given names. If any rule name not found - throw Error.
Errors can be disabled by second param.</p>
<p>Returns list of found rule names (if no exception happened).</p>
<p>See also <a href="#Ruler.disable" class="link-short" title="Ruler.disable (class method)" data-id="ruler.disable">Ruler.disable</a>, <a href="#Ruler.enableOnly" class="link-short" title="Ruler.enableOnly (class method)" data-id="ruler.enableonly">Ruler.enableOnly</a>.</p>
</div></div></article><article class="docblock" id="Ruler.enableOnly" data-title="Ruler.enableOnly (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.enableOnly" class="" title="Ruler.enableOnly (class method)" data-id="ruler.enableonly">enableOnly</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>enableOnly</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L281">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.enableOnly(list[, ignoreInvalid])</li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">list</li><li><ul class="argument-types"><li class="argument-type">String</li><li class="argument-type">Array</li></ul></li><li class="argument-description"><p>list of rule names to enable (whitelist).</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">ignoreInvalid</li><li><ul class="argument-types"><li class="argument-type">Boolean</li></ul></li><li class="argument-description"><p>set <code>true</code> to ignore errors when rule not found.</p>
</li></ul></li></ul><p>Enable rules with given names, and disable everything else. If any rule name
not found - throw Error. Errors can be disabled by second param.</p>
<p>See also <a href="#Ruler.disable" class="link-short" title="Ruler.disable (class method)" data-id="ruler.disable">Ruler.disable</a>, <a href="#Ruler.enable" class="link-short" title="Ruler.enable (class method)" data-id="ruler.enable">Ruler.enable</a>.</p>
</div></div></article><article class="docblock" id="Ruler.getRules" data-title="Ruler.getRules (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.getRules" class="" title="Ruler.getRules (class method)" data-id="ruler.getrules">getRules</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>getRules</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L331">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.getRules(chainName)</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><p>Return array of active functions (rules) for given chain name. It analyzes
rules configuration, compiles caches if not exists and returns result.</p>
<p>Default chain name is <code>''</code> (empty string). It can't be skipped. That's
done intentionally, to keep signature monomorphic for high speed.</p>
</div></div></article><article class="docblock" id="Ruler.push" data-title="Ruler.push (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Ruler" class="" title="Ruler (class)" data-id="ruler">Ruler</a></li><li><a href="#Ruler.push" class="" title="Ruler.push (class method)" data-id="ruler.push">push</a></li></ul><h2 title="class method"><span class="name_prefix">Ruler.</span>push</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/ruler.mjs#L225">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Ruler.push(ruleName, fn[, options])</li></ul></li></ul><ul class="arguments"><li><ul class="argument"><li class="argument-name">ruleName</li><li><ul class="argument-types"><li class="argument-type">String</li></ul></li><li class="argument-description"><p>name of added rule.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">fn</li><li><ul class="argument-types"><li class="argument-type">Function</li></ul></li><li class="argument-description"><p>rule function.</p>
</li></ul></li><li><ul class="argument"><li class="argument-name">options</li><li><ul class="argument-types"><li class="argument-type">Object</li></ul></li><li class="argument-description"><p>rule options (not mandatory).</p>
</li></ul></li></ul><p>Push new rule to the end of chain. See also
<a href="#Ruler.before" class="link-short" title="Ruler.before (class method)" data-id="ruler.before">Ruler.before</a>, <a href="#Ruler.after" class="link-short" title="Ruler.after (class method)" data-id="ruler.after">Ruler.after</a>.</p>
<h5>Options:</h5>
<ul>
<li><strong>alt</strong> - array with names of &quot;alternate&quot; chains.</li>
</ul>
<h5>Example</h5>
<pre class="hljs language-javascript"><code><span class="hljs-keyword">var</span> md = <span class="hljs-built_in">require</span>(<span class="hljs-string">&#x27;markdown-it&#x27;</span>)();
md.<span class="hljs-property">core</span>.<span class="hljs-property">ruler</span>.<span class="hljs-title function_">push</span>(<span class="hljs-string">&#x27;my_rule&#x27;</span>, <span class="hljs-keyword">function</span> <span class="hljs-title function_">replace</span>(<span class="hljs-params">state</span>) {
<span class="hljs-comment">//...</span>
});
</code></pre>
</div></div></article><article class="docblock" id="Token" data-title="Token (class)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li></ul><h2 title="class">Token</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L6">View source</a></div></header><div class="section constructor"><h3>Constructor</h3><div class="content"></div><ul class="method-list"><li><a href="#Token.new" class="" title="new Token (constructor)" data-id="new token">new Token</a></li></ul></div><div class="section class_methods"><h3>Class methods</h3><div class="content"><ul class="method-list"><li><a href="#Token.attrGet" class="" title="Token.attrGet (class method)" data-id="token.attrget">attrGet</a></li><li><a href="#Token.attrIndex" class="" title="Token.attrIndex (class method)" data-id="token.attrindex">attrIndex</a></li><li><a href="#Token.attrJoin" class="" title="Token.attrJoin (class method)" data-id="token.attrjoin">attrJoin</a></li><li><a href="#Token.attrPush" class="" title="Token.attrPush (class method)" data-id="token.attrpush">attrPush</a></li><li><a href="#Token.attrSet" class="" title="Token.attrSet (class method)" data-id="token.attrset">attrSet</a></li></ul></div></div><div class="section instance_properties"><h3>Instance properties</h3><div class="content"><ul class="method-list"><li><a href="#Token.prototype.attrs" class="" title="Token#attrs (instance property)" data-id="token#attrs">attrs</a></li><li><a href="#Token.prototype.block" class="" title="Token#block (instance property)" data-id="token#block">block</a></li><li><a href="#Token.prototype.children" class="" title="Token#children (instance property)" data-id="token#children">children</a></li><li><a href="#Token.prototype.content" class="" title="Token#content (instance property)" data-id="token#content">content</a></li><li><a href="#Token.prototype.hidden" class="" title="Token#hidden (instance property)" data-id="token#hidden">hidden</a></li><li><a href="#Token.prototype.info" class="" title="Token#info (instance property)" data-id="token#info">info</a></li><li><a href="#Token.prototype.level" class="" title="Token#level (instance property)" data-id="token#level">level</a></li><li><a href="#Token.prototype.map" class="" title="Token#map (instance property)" data-id="token#map">map</a></li><li><a href="#Token.prototype.markup" class="" title="Token#markup (instance property)" data-id="token#markup">markup</a></li><li><a href="#Token.prototype.meta" class="" title="Token#meta (instance property)" data-id="token#meta">meta</a></li><li><a href="#Token.prototype.nesting" class="" title="Token#nesting (instance property)" data-id="token#nesting">nesting</a></li><li><a href="#Token.prototype.tag" class="" title="Token#tag (instance property)" data-id="token#tag">tag</a></li><li><a href="#Token.prototype.type" class="" title="Token#type (instance property)" data-id="token#type">type</a></li></ul></div></div></article><article class="docblock" id="Token.new" data-title="new Token (constructor)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.new" class="" title="new Token (constructor)" data-id="new token">new</a></li></ul><h2 title="constructor"><span class="name_prefix">Token.</span>new</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L12">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">new Token(type, tag, nesting)</li></ul></li></ul><p>Create new token and fill passed properties.</p>
</div></div></article><article class="docblock" id="Token.attrGet" data-title="Token.attrGet (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.attrGet" class="" title="Token.attrGet (class method)" data-id="token.attrget">attrGet</a></li></ul><h2 title="class method"><span class="name_prefix">Token.</span>attrGet</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L166">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token.attrGet(name)</li></ul></li></ul><p>Get the value of attribute <code>name</code>, or null if it does not exist.</p>
</div></div></article><article class="docblock" id="Token.attrIndex" data-title="Token.attrIndex (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.attrIndex" class="" title="Token.attrIndex (class method)" data-id="token.attrindex">attrIndex</a></li></ul><h2 title="class method"><span class="name_prefix">Token.</span>attrIndex</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L121">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token.attrIndex(name)</li><li><ul class="signature-values"><li>Number</li></ul></li></ul></li></ul><p>Search attribute index by name.</p>
</div></div></article><article class="docblock" id="Token.attrJoin" data-title="Token.attrJoin (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.attrJoin" class="" title="Token.attrJoin (class method)" data-id="token.attrjoin">attrJoin</a></li></ul><h2 title="class method"><span class="name_prefix">Token.</span>attrJoin</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L181">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token.attrJoin(name, value)</li></ul></li></ul><p>Join value to existing attribute via space. Or create new attribute if not
exists. Useful to operate with token classes.</p>
</div></div></article><article class="docblock" id="Token.attrPush" data-title="Token.attrPush (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.attrPush" class="" title="Token.attrPush (class method)" data-id="token.attrpush">attrPush</a></li></ul><h2 title="class method"><span class="name_prefix">Token.</span>attrPush</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L137">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token.attrPush(attrData)</li></ul></li></ul><p>Add <code>[ name, value ]</code> attribute to list. Init attrs if necessary</p>
</div></div></article><article class="docblock" id="Token.attrSet" data-title="Token.attrSet (class method)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.attrSet" class="" title="Token.attrSet (class method)" data-id="token.attrset">attrSet</a></li></ul><h2 title="class method"><span class="name_prefix">Token.</span>attrSet</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L150">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token.attrSet(name, value)</li></ul></li></ul><p>Set <code>name</code> attribute to <code>value</code>. Override old value if exists.</p>
</div></div></article><article class="docblock" id="Token.prototype.attrs" data-title="Token#attrs (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.attrs" class="" title="Token#attrs (instance property)" data-id="token#attrs">attrs</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>attrs</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L32">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#attrs</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><p>Html attributes. Format: <code>[ [ name1, value1 ], [ name2, value2 ] ]</code></p>
</div></div></article><article class="docblock" id="Token.prototype.block" data-title="Token#block (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.block" class="" title="Token#block (instance property)" data-id="token#block">block</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>block</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L105">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#block</li><li><ul class="signature-values"><li>Boolean</li></ul></li></ul></li></ul><p>True for block-level tokens, false for inline tokens.
Used in renderer to calculate line breaks</p>
</div></div></article><article class="docblock" id="Token.prototype.children" data-title="Token#children (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.children" class="" title="Token#children (instance property)" data-id="token#children">children</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>children</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L64">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#children</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><p>An array of child nodes (inline and img tokens)</p>
</div></div></article><article class="docblock" id="Token.prototype.content" data-title="Token#content (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.content" class="" title="Token#content (instance property)" data-id="token#content">content</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>content</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L72">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#content</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>In a case of self-closing tag (code, html, fence, etc.),
it has contents of this tag.</p>
</div></div></article><article class="docblock" id="Token.prototype.hidden" data-title="Token#hidden (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.hidden" class="" title="Token#hidden (instance property)" data-id="token#hidden">hidden</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>hidden</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L113">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#hidden</li><li><ul class="signature-values"><li>Boolean</li></ul></li></ul></li></ul><p>If it's true, ignore this element when rendering. Used for tight lists
to hide paragraphs.</p>
</div></div></article><article class="docblock" id="Token.prototype.info" data-title="Token#info (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.info" class="" title="Token#info (instance property)" data-id="token#info">info</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>info</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L90">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#info</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>Additional information:</p>
<ul>
<li>Info string for &quot;fence&quot; tokens</li>
<li>The value &quot;auto&quot; for autolink &quot;link_open&quot; and &quot;link_close&quot; tokens</li>
<li>The string value of the item marker for ordered-list &quot;list_item_open&quot; tokens</li>
</ul>
</div></div></article><article class="docblock" id="Token.prototype.level" data-title="Token#level (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.level" class="" title="Token#level (instance property)" data-id="token#level">level</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>level</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L57">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#level</li><li><ul class="signature-values"><li>Number</li></ul></li></ul></li></ul><p>nesting level, the same as <code>state.level</code></p>
</div></div></article><article class="docblock" id="Token.prototype.map" data-title="Token#map (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.map" class="" title="Token#map (instance property)" data-id="token#map">map</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>map</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L39">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#map</li><li><ul class="signature-values"><li>Array</li></ul></li></ul></li></ul><p>Source map info. Format: <code>[ line_begin, line_end ]</code></p>
</div></div></article><article class="docblock" id="Token.prototype.markup" data-title="Token#markup (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.markup" class="" title="Token#markup (instance property)" data-id="token#markup">markup</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>markup</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L79">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#markup</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>'*' or '_' for emphasis, fence string for fence, etc.</p>
</div></div></article><article class="docblock" id="Token.prototype.meta" data-title="Token#meta (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.meta" class="" title="Token#meta (instance property)" data-id="token#meta">meta</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>meta</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L97">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#meta</li><li><ul class="signature-values"><li>Object</li></ul></li></ul></li></ul><p>A place for plugins to store an arbitrary data</p>
</div></div></article><article class="docblock" id="Token.prototype.nesting" data-title="Token#nesting (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.nesting" class="" title="Token#nesting (instance property)" data-id="token#nesting">nesting</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>nesting</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L50">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#nesting</li><li><ul class="signature-values"><li>Number</li></ul></li></ul></li></ul><p>Level change (number in {-1, 0, 1} set), where:</p>
<ul>
<li><code>1</code> means the tag is opening</li>
<li><code>0</code> means the tag is self-closing</li>
<li><code>-1</code> means the tag is closing</li>
</ul>
</div></div></article><article class="docblock" id="Token.prototype.tag" data-title="Token#tag (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.tag" class="" title="Token#tag (instance property)" data-id="token#tag">tag</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>tag</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L25">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#tag</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>html tag name, e.g. &quot;p&quot;</p>
</div></div></article><article class="docblock" id="Token.prototype.type" data-title="Token#type (instance property)"><header><ul class="breadcrumbs"><li><a href="#home">Home</a></li><li><a href="#Token" class="" title="Token (class)" data-id="token">Token</a></li><li><a href="#Token.prototype.type" class="" title="Token#type (instance property)" data-id="token#type">type</a></li></ul><h2 title="instance property"><span class="name_prefix">Token#</span>type</h2><div class="source"><a href="https://github.com/markdown-it/markdown-it/blob/0fe7cc/lib/token.mjs#L18">View source</a></div></header><div class="section method"><div class="content"><ul class="signatures"><li><ul class="signature"><li class="signature-call">Token#type</li><li><ul class="signature-values"><li>String</li></ul></li></ul></li></ul><p>Type of the token (string, e.g. &quot;paragraph_open&quot;)</p>
</div></div></article><footer class="footer"><p>Last updated on Mon, 18 Mar 2024 23:17:43 GMT. Generated by <a href="http://github.com/nodeca/ndoc">ndoc</a></p></footer></div></body></html>