Skip to content

Commit d7d3e1e

Browse files
committed
add sub, sup, admonition custom bbcodes
1 parent ff39778 commit d7d3e1e

1 file changed

Lines changed: 90 additions & 0 deletions

File tree

bb_codes.xml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,79 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<bb_codes>
3+
<bb_code bb_code_id="admonition" bb_code_mode="replace" has_option="yes" option_regex="/^(note|tip|important|warning|caution)$/i" trim_lines_after="1" plain_children="0" disable_smilies="0" disable_nl2br="0" disable_autolink="0" allow_empty="0" allow_signature="1" editor_icon_type="fa" editor_icon_value="bell" title="Admonition (GitHub alerts)">
4+
<desc><![CDATA[GitHub-style alerts/admonitions: NOTE, TIP, IMPORTANT, WARNING, CAUTION.]]></desc>
5+
<example><![CDATA[[admonition=warning]
6+
Be careful with this step.
7+
[/admonition]]]></example>
8+
<output><![CDATA[]]></output>
9+
<replace_html><![CDATA[<style>
10+
/* you can cut this style out and place it in your extra.css template so it's not repeated for each admonition. */
11+
.bbWrapper .rgAdmonition{
12+
--rgAdmonition-accent: #0969da; /* note */
13+
--rgAdmonition-bg: rgba(9,105,218,.10);
14+
margin: 1em 0;
15+
padding: .75em 1em;
16+
border-left: 4px solid var(--rgAdmonition-accent);
17+
background: var(--rgAdmonition-bg);
18+
border-radius: 6px;
19+
}
20+
21+
.bbWrapper .rgAdmonition--tip{
22+
--rgAdmonition-accent: #1a7f37;
23+
--rgAdmonition-bg: rgba(26,127,55,.12);
24+
}
25+
.bbWrapper .rgAdmonition--important{
26+
--rgAdmonition-accent: #8250df;
27+
--rgAdmonition-bg: rgba(130,80,223,.12);
28+
}
29+
.bbWrapper .rgAdmonition--warning{
30+
--rgAdmonition-accent: #9a6700;
31+
--rgAdmonition-bg: rgba(154,103,0,.12);
32+
}
33+
.bbWrapper .rgAdmonition--caution{
34+
--rgAdmonition-accent: #d1242f;
35+
--rgAdmonition-bg: rgba(209,36,47,.12);
36+
}
37+
38+
.bbWrapper .rgAdmonition-header{
39+
display: flex;
40+
align-items: center;
41+
gap: .5em;
42+
font-weight: 600;
43+
margin: 0 0 .5em 0;
44+
color: var(--rgAdmonition-accent);
45+
}
46+
.bbWrapper .rgAdmonition-label{ text-transform: capitalize; }
47+
.bbWrapper .rgAdmonition-label:empty::before{ content: "Note"; }
48+
49+
/* Hide the leading and trailing newline. */
50+
.bbWrapper .rgAdmonition-body > br:first-child{ display: none; }
51+
.bbWrapper .rgAdmonition-body > br:last-child{ display: none; }
52+
53+
.bbWrapper .rgAdmonition-icon{
54+
flex: 0 0 auto;
55+
display: none;
56+
}
57+
.bbWrapper .rgAdmonition--note .rgAdmonition-icon.fa-info-circle,
58+
.bbWrapper .rgAdmonition--tip .rgAdmonition-icon.fa-lightbulb,
59+
.bbWrapper .rgAdmonition--important .rgAdmonition-icon.fa-exclamation-circle,
60+
.bbWrapper .rgAdmonition--warning .rgAdmonition-icon.fa-exclamation-triangle,
61+
.bbWrapper .rgAdmonition--caution .rgAdmonition-icon.fa-stop-circle{ display: inline-block; }
62+
</style>
63+
<aside class="rgAdmonition rgAdmonition--{option}">
64+
<div class="rgAdmonition-header">
65+
<i data-xf-init="icon" class="fas fa-info-circle rgAdmonition-icon"></i>
66+
<i data-xf-init="icon" class="fas fa-lightbulb rgAdmonition-icon"></i>
67+
<i data-xf-init="icon" class="fas fa-exclamation-circle rgAdmonition-icon"></i>
68+
<i data-xf-init="icon" class="fas fa-exclamation-triangle rgAdmonition-icon"></i>
69+
<i data-xf-init="icon" class="fas fa-stop-circle rgAdmonition-icon"></i>
70+
<span class="rgAdmonition-label">{option}</span>
71+
</div>
72+
<div class="rgAdmonition-body">{text}</div>
73+
</aside>]]></replace_html>
74+
<replace_html_email><![CDATA[]]></replace_html_email>
75+
<replace_text><![CDATA[]]></replace_text>
76+
</bb_code>
377
<bb_code bb_code_id="abbr" bb_code_mode="replace" has_option="yes" trim_lines_after="0" plain_children="0" disable_smilies="0" disable_nl2br="0" disable_autolink="0" allow_empty="0" allow_signature="1" editor_icon_type="fa" editor_icon_value="acorn" title="Abbreviation">
478
<desc><![CDATA[defines an abbreviation or an acronym]]></desc>
579
<example><![CDATA[The [abbr=World Health Organization]WHO[/abbr] was founded in 1948.]]></example>
@@ -54,4 +128,20 @@ Normal:
54128
<replace_html_email><![CDATA[]]></replace_html_email>
55129
<replace_text><![CDATA[]]></replace_text>
56130
</bb_code>
131+
<bb_code bb_code_id="sub" bb_code_mode="replace" has_option="no" trim_lines_after="0" plain_children="0" disable_smilies="0" disable_nl2br="0" disable_autolink="0" allow_empty="0" allow_signature="1" editor_icon_type="fa" editor_icon_value="fa-subscript" title="Subscript">
132+
<desc><![CDATA[Subscript text]]></desc>
133+
<example><![CDATA[H[sub]2[/sub]O]]></example>
134+
<output><![CDATA[]]></output>
135+
<replace_html><![CDATA[<sub>{text}</sub>]]></replace_html>
136+
<replace_html_email><![CDATA[]]></replace_html_email>
137+
<replace_text><![CDATA[]]></replace_text>
138+
</bb_code>
139+
<bb_code bb_code_id="sup" bb_code_mode="replace" has_option="no" trim_lines_after="0" plain_children="0" disable_smilies="0" disable_nl2br="0" disable_autolink="0" allow_empty="0" allow_signature="1" editor_icon_type="fa" editor_icon_value="fa-superscript" title="Superscript">
140+
<desc><![CDATA[Displays text as superscript]]></desc>
141+
<example><![CDATA[e=mc[sup]2[/sup]]]></example>
142+
<output><![CDATA[]]></output>
143+
<replace_html><![CDATA[<sup>{text}</sup>]]></replace_html>
144+
<replace_html_email><![CDATA[]]></replace_html_email>
145+
<replace_text><![CDATA[]]></replace_text>
146+
</bb_code>
57147
</bb_codes>

0 commit comments

Comments
 (0)