7Special characters and escaping characters

GitHub uses the Segoe UI font (pronounced seg-o-ee) as standard across all its Wiki pages (at least it does on Windows based browsers). Segoe is a large font with a very great number of characters all of which can be accessed by using escape codes.

“Escaping” a character is a term that applies to special characters that would otherwise be used to format the text in some way (asterisks for example), it allows the character to be displayed as a character rather than being interpreted as a formatting instruction.

This “escaping” process takes different forms for different languages (Markdown, HTML &c.), but always results in the true character being rendered.

This escaping process allows the full range of the Segoe UI font characters to be accessed (not just the ones that can be entered from a keyboard). Thing like this:

▛ ▜ ♑ ♞ ♬

There is a spreadsheet with the full Segoe UI character set here:

It’s a big list, there are 40,000 characters in it (not all of which render on GitHub, but 26,684 of them do).

These are also listed in Appendix C of this Wiki.

7.1Escape characters and character codes

Markdown has a mechanism for displaying characters that would otherwise be use to format text (asterisks for example), this mechanism is called “escaping the character”. It is also possible to use a Unicode value to display a specific character (in either decimal or hexadecimal format), plus all the HTML symbol codes (the ones that begin with an ampersand) are also supported.

7.1.1Markdown escape sequences

With Markdown, to display a literal character (i.e. to make the character appear in the text rather than format the text), precede it with a backslash character \.

For example if the following Markdown text were used:

^{Markdown and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽
* Without a backslash this is rendered as a list.
${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
Without a backslash this is rendered as a list.

Section 8 explains about lists. The point here is that if we wish to display the asterisk as an asterisk, we need to escape it (by adding a backslash):

^{Markdown and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽
\* With a backslash it renders as an asterisk.
${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* With a backslash it renders as an asterisk.

The following characters can all be “escaped” by placing a backslash before the character:

Character	Name	Escape symbol
\	Backslash	`\\`
`	Backtick	\`
*	Asterisk	`\*`
_	Underscore	`\_`
{ }	Braces	`\{` `\}`
[ ]	Brackets	`\[` `\]`
< >	Angle brackets	`\<` `\>`
( )	Parentheses	`$` `$`
#	Hash sign	`\#`
+	Plus sign	`\+`
-	Minus sign (hyphen)	`\-`
.	Full stop	`\.`
!	Exclamation mark	`\!`
\|	Pipe	`\\|`
^{Table 7.1 — Markdown escapable characters}

⬆️ Top

7.1.2HTML escape sequences

Like Markdown, HTML has reserved characters, mostly the less than < and greater than signs >. These can also be escaped in HTML by using escape sequences.

There are several of these reserved characters in HTML:

^{Table 7.2 — HTML reserved characters and escape sequences}
Less than	<	Replacement code:	`<`
Greater than	>	Replacement code:	`>`
Ampersand	&	Replacement code:	`&`
Double quotation mark	"	Replacement code:	`"`
Single quotation mark	'	Replacement code:	`'`

HTML provides a series of escape sequences (sometimes called symbol codes) that start with an ampersand & followed by a meaningful group of characters (well, meaningful in a way, some require a degree of interpretation) and ending with a semicolon ;. For example, the escape sequence for a less than symbol < is <.

Escape sequences always start with the ampersand character & and end with a semicolon ;.

Basically, HTML escape sequences are a group of characters that are translated by the browser into a specific symbol.

Whenever the browser comes across the sequence of characters <, it will display a less than sign <.

There are many other HTML escape sequences for characters not accessible via the key board μ for example displays the Greek Mu character µ. Appendix A contains a full list of all HTML escape sequences.

All of these HTML escape sequences work in Markdown, just put them in the text and GitHub will display them correctly.

⬆️ Top

7.1.3HTML decimal and hexadecimal escape codes

The escape sequences of the previous section are one way of displaying reserved and non-keyboard characters. These escape sequences are intended to be intuitive mnemonics for the symbols they represent (that said, I usually have to look them up). The problem is that not every character has one.

It is possible to use the Unicode value of the character as an “escape code” (as opposed to an escape sequence).

Every character that can be displayed has a Unicode value (a number), specifically a value given using the Unicode transformation format-8 (UTF-8^💠1). For example, the letter “A” has a Unicode value of 65, “B” 66 &c., there is a full list on Wikipedia: https://en.wikipedia.org/wiki/List_of_Unicode_characters.

Appendix C contains a spreadsheet with the full character set.

In HTML and GitHub Flavoured Markdown, any character can be entered by using its Unicode value as an escape code. HTML escape codes are preceded by the ampersand and hash characters &# and finished with a semicolon ;.

Continuing the previous example Unicode value for the letter “A” is 65 (decimal). To enter the letter “A” in HTML using an escape code, use the following:

A

GitHub Markdown accepts the use of both HTML escape sequence and escape codes.

The following tables gives a list of common escape sequence and escape codes Appendix A has a complete list of all HTML escape sequences and codes (they mostly all work in GitHub Markdown, there are some exceptions though, these are listed in section 7.2.1).

Mathematical		HTML	Code	athematical		HTML	Code
×	Multiplication sign	×	×	∩	Intersection	∩	∩
÷	Division sign	÷	÷	∫	Integral	∫	∫
−	Minus sign	−	−	≈	Almost equal to	≈	≈
±	Plus/minus sign	±	±	≠	Not equal to	≠	≠
⁄	Fraction slash	&frasl;	⁄	≡	Identical to	&equiv;	≡
∏	N-array product	∏	∏	<	Less than	<	<
∑	N-array summation	∑	∑	>	Greater than	>	>
√	Square root	√	√	≤	Less than or equal to	≤	≤
∞	Infinity	∞	∞	≥	Greater than or equal to	≥	≥
HTML reserved		HTML	Code	HTML reserved		HTML	Code
<	Less than	<	<	"	Quotation mark	"	"
>	Greater than	>	>	'	Single quote	'	'
&	Ampersand	&	&
Miscellaneous		HTML	Code	Miscellaneous		HTML	Code
←	Leftwards arrow	←	←	¦	Broken vertical bar	¦	¦
↑	Upwards arrow	↑	↑	°	Degree sign	°	°
→	Rightwards arrow	→	→	·	Middle dot	·	·
↓	Downwards arrow	↓	↓	•	Bullet	•	•
↔	Left right arrow	↔	↔
	Spacing	HTML	Code		Spacing	HTML	Code
█ █	Em space	&emsp;		█ █	Space
█ █	Number space	&numsp;		█ █	Em/4 space	&emsp14;
█ █	En space	&ensp;		█ █	Punctuation space	&puncsp;
█ █	Em/3 space	&emsp13;		█ █	Thin space
█ █	Non-breaking space			█ █	Hair space	&hairsp;
Currency		HTML	Code	Currency		HTML	Code
$	Dollar	&dollar;	$	¢	Cent sign	¢	¢
£	Pound sign	£	£	¥	Yen	¥	¥
€	Euro sign	€		¤	Curren	¤	¤
Numbers		HTML	Code	Numbers		HTML	Code
¹	Superscript one	¹	¹	½	Fraction one half	½	½
²	Superscript two	²	²	¼	Fraction one quarter	&frac14	¼
³	Superscript three	³	³	¾	Fraction three quarters	&frac34	¾
Punctuation		HTML	Code	Punctuation		HTML	Code
¡	Inverted exclamation mark	¡	¡	…	Horizontal ellipsis	…	…
¿	Inverted question mark	¿	¿	‾	Overline	&oline;	‾
“	Left double quote	“	“	§	Section sign	§	§
”	Right double quote	”	”	¶	Paragraph sign	¶	¶
„	Double low-9 quote	&bdquo;	„	©	Copyright sign	©	©
‘	Left single quote	‘	‘	®	Registered trademark sign	®	®
’	Right single quote	& rsquo;	’	™	Trademark sign	™	™
‚	Single low-9 quote	&sbquo;	‚	¬	Not sign	¬	¬
◊	Lozenge	&loz;	◊	µ	Micro sign	µ	µ
«	Left double angle quote	«	«	‰	Per mille sign	&permil;	‰
»	Right double angle quote	»	»	′	Prime (straight quote)	′	′
‹	Single left angle quote	&lsaquo;	‹	″	Double prime (straight quote)	″	″
›	Single right angle quote	&rsaquo;	›	†	Dagger	&dagger;	†
–	En dash	–	–	‡	Double dagger	&Dagger;	‡
—	Em dash	—	—
Greek small letters		HTML	Code	Greek capital letters		HTML	Code
α	Alpha	&alpha	α	Α	Alpha	&Alpha	Α
β	Beta	β	β	Β	Beta	Β	Β
γ	Gamma	γ	γ	Γ	Gamma	Γ	Γ
δ	Delta	δ	δ	Δ	Delta	Δ	Δ
ε	Epsilon	ε	ε	Ε	Epsilon	Ε	Ε
ζ	Zeta	ζ	ζ	Ζ	Zeta	Ζ	Ζ
η	Eta	η	η	Η	Eta	Η	Η
θ	Theta	θ	θ	Θ	Theta	Θ	Θ
ι	Iota	ι	ι	Ι	Iota	Ι	Ι
κ	Kappa	κ	κ	Κ	Kappa	Κ	Κ
λ	Lambda	λ	λ	Λ	Lambda	Λ	Λ
μ	Mu	μ	μ	Μ	Mu	Μ	Μ
ν	Nu	ν	ν	Ν	Nu	Ν	Ν
ξ	Xi	ξ	ξ	Ξ	Xi	Ξ	Ξ
ο	Omicron	ο	ο	Ο	Omicron	Ο	Ο
π	Pi	π	π	Π	Pi	Π	Π
ρ	Rho	ρ	ρ	Ρ	Rho	Ρ	Ρ
ς	Sigma 1	&sigmaf;	ς	Σ	Sigma	Σ	Σ
σ	Sigma 2	σ	σ
τ	Tau	τ	τ	Τ	Tau	Τ	Τ
υ	Upsilon	υ	υ	Υ	Upsilon	Υ	Υ
φ	Phi	φ	φ	Φ	Phi	Φ	Φ
χ	Chi	χ	χ	Χ	Chi	Χ	Χ
ψ	Psi	ψ	ψ	Ψ	Psi	Ψ	Ψ
ω	Omega	ω	ω	Ω	Omega	Ω	Ω
^{Table 7.3 — HTML common escape sequences and codes}

Hexadecimal escape codes

The escape codes listed above use decimal numbers for the Unicode characters A where 65 is the decimal value of the Unicode number for “A”.

The escape codes can also be given in hexadecimal format and this will work within GitHub Markdown and Wiki pages. The hexadecimal equivalent of 65 is 41. To use the hexadecimal number in an escape code, precede it with &#x and follow it with a semicolon ;. Thus:

https://docs.github.com/en/enterprise-cloud@latest

A and A both display the “A” character.

Tip

Being able to use hexadecimal notation is useful; simply because Unicode char-acters are generally given in hexadecimal format. U+0041 is Unicode for “A”.

⬆️ Top

7.2Special space characters

Markdown (and GitHub Markdown) ignore multiple spaces. In the following example, the two words “TEST” are separated by five spaces:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽
TEST TEST
${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
TEST TEST
^{Table 7.4 — Markdown ignores multiple consecutive spaces}

Markdown simply ignores the multiple, consecutive spaces.

Markdown does not, however, ignore the non-breaking space character  , this has exactly the same spacing as a normal space character, but will always be rendered by Markdown.

This is the same example with five non-breaking spaces between the two words “TEST”

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽
TEST     TEST
${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
TEST TEST
^{Table 7.4 — Markdown does not ignore multiple consecutive non-breaking spaces}

Markdown supports several such space characters; this is a full list — the spaces are bounded by full blocks to give an idea of the width of each type of space, the second column shows four of each type of space to emphasize the different relative sizes:

Single Space	Four Spaces	Name	Escape sequence
█ █	█ █	Em space	`&emsp;`
█ █	█ █	Number space	`&numsp;`
█ █	█ █	En space	`&ensp;`
█ █	█ █	Em/3 space	`&emsp13;`
█ █	█ █	Non-breaking space	` `
█ █	█ █	Em/4 space	`&emsp14;`
█ █	█ █	Punctuation space	`&puncsp;`
█ █	█ █	Thin space	` `
█ █	█ █	Hair space	`&hairsp;`
^{Table 7.6 — Different spaces and relative widths}

These different size spaces are used extensively in the PracticalSeries Wiki page headings and tables of contents to ensure that the gaps between the heading numbers and the heading text are consistent.

The size of the gap between the heading number on the left and the heading text on the right, depends on how many numbers there are (90.10.20 has six numbers, 1.2.4 only has three. Both are valid section numbers, but the first will have a smaller space between the last full stop and the heading text).

The width of each type of space depends where the space is used. The space in a heading (all headings are different) is generally larger than the same space used in body text. Similarly, if the text is in a sidebar or footer, the spacings are again different for headings and body text.

The following tables give the width in pixels of each different type of space character for all headings and body text in both the main page area and sidebars/footers (there is no difference between space sizes in sidebars and in footers, they are the same).

Space witdths in pixels for the main page
	H1	H2	H3	H4	H5	H6	Body text
Em space	32.00	24.00	20.00	16.00	14.00	13.60	16.00
Number space	17.77	13.33	11.10	8.87	7.77	7.53	8.63
En space	16.00	12.00	10.00	8.00	7.00	6.80	8.00
Em/3 space	10.63	8.00	6.63	5.33	4.67	4.53	5.33
Normal space	8.80	6.60	5.47	4.40	3.87	3.73	4.37
Non-breaking space	8.80	6.60	5.47	4.40	3.87	3.73	4.37
Em/4 space	8.00	6.00	5.00	4.00	3.50	3.40	4.00
Punctuation space	7.70	5.80	4.80	3.87	3.37	3.27	3.47
Thin space	6.40	4.83	4.00	3.20	2.80	2.70	3.20
Hair space	4.00	3.00	2.50	2.00	1.77	1.70	2.00
Two blocks ██	47.00	35.00	30.00	24.00	21.00	21.00	24.00
^{Table 7.7 — Space widths in the main page (in pixels)}

Space witdths in pixels for sidebars and footers
	H1	H2	H3	H4	H5	H6	Body text
Em space	24.00	18.00	15.00	12.00	10.50	10.20	12.00
Number space	13.33	10.00	8.30	6.67	5.83	5.63	6.47
En space	12.00	9.00	7.50	6.00	5.27	5.10	6.00
Em/3 space	8.00	6.00	4.97	4.00	3.50	3.40	4.00
Normal space	6.60	4.93	4.10	3.30	2.90	2.80	3.30
Non-breaking space	6.60	4.93	4.10	3.30	2.90	2.80	3.30
Em/4 space	6.00	4.50	3.73	3.00	2.63	2.53	3.00
Punctuation space	5.80	4.33	3.60	2.90	2.53	2.43	2.60
Thin space	4.83	3.60	3.00	2.40	2.10	2.03	2.40
Hair space	3.00	2.23	1.87	1.47	1.33	1.27	1.50
Two blocks ██	35.00	27.00	23.00	18.00	16.00	16.00	18.00
^{Table 7.8 — Space widths in sidebars and footers (in pixels)}

Note

All widths in the above tables are measured using the Edge browser with page magnification set to 100% on a monitor set to its native resolution (2560 × 1440 px).

⬆️ Top

7.2.1Escape sequence restrictions in GitHub HTML

For some reason, some HTML escape sequences do not work in GitHub Wiki Markdown.

This is true only when the escape sequences are between HTML tags, i.e. in a table <table>…</table> or between <p>…</p> tags for example.

Mainly this affects some of the special space characters:

Name	Non-functional Esc sequence	Replacement Esc code (dec)	Replacement Esc code (hex)
Number space	`&numsp;`	` `	` `
Em/3 space	`&emsp13;`	` `	` `
Em/4 space	`&emsp14;`	` `	` `
Punctuation space	`&puncsp;`	` `	` `
Hair space	`&hairsp;`	` `	` `
^{Table 7.9 — Escape sequences that do not work in GitHub Markdown HTML}

Important

This is only a partial list of the most common escape sequences, a full list is available in Appendix A.2

The alternate decimal and hexadecimal escape codes work everywhere.

Note

The above escape sequences work perfectly well with just Markdown, it is only when they are inside an HTML tag that problems occur.

To complicate things, it is only Wiki Markdown that is affected, all the escape sequences work perfectly well in repository Markdown, see section 5.6.

⬆️ Top

7.3Emojis and emoticons

Emojis and emoticons are pictograms that can be embedded in text to convey some form of emotion, smiley face symbols, that sort of thing. They are popular with teenagers and the intellectually challenged.

GitHub supports a full set of Unicode emojis and these can be pasted directly into a Wiki or Markdown page, they can be entered using short name abbreviations or they can be entered as either decimal escape codes &#…; or hexadecimal escape codes &#x…;.

There is a standard version of the short names that can be used for emojis, these are managed by the Unicode CLDR (Common Locale Data Repository), available here: https://cldr.unicode.org/.

The Unicode CLDR provides a full list of all emoji characters, their Unicode character (or string of characters) and the formal short form name, the list is available here: https://unicode.org/emoji/charts/full-emoji-list.html.

GitHub allows short names to be used, these are surrounded by a colon : before and after, thus, the crossed fingers emoji is displayed in Markdown with the short name:

:crossed_fingers: it looks like this: 🤞

The problem with this approach is that GitHub, in its wisdom, decided not to use the standardised (Unicode CDLR) short names, it uses its own versions with slightly different names.

I thought at first this was so that GitHub could use shorter names than the standard CLDR, for example where the CLDR has the name grinning face (😀)and GitHub just has :grinning:.

This argument falls down with the CLDR: smiling face with hearts and the GitHub :smiling_face_with_three_hearts: (🥰). So I’ve no idea why GitHub have differed.

Appendix B contains a full list of all the emojis. For completeness, it shows both the GitHub short name and the standardised CDLR short name, the decimal escape code and the hexadecimal escape code.

A note by the Author about emojis

Well, I’m an engineer and engineers in particular are not at home to emojis (we’re not generally tainted with emotion). Engineers have only one rule for using emojis: ${\LARGE \color{#C00000}\text{DON'T\ EVER!}}$

⬆️ Top

7.4Comments

It is possible to insert comments in Markdown text.

Comments are visible in Markdown, but are not displayed when the page is rendered (on a web browser).

Comments in Markdown are identical to those in HTML.

Any text between  is a comment and will not be displayed:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽
Comments <!-- Like this --> are not displayed
${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽
<p>Comments <!-- Like this --> are not displayed</p>
${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
Comments are not displayed
^{Table 7.10 — Body text examples}

I think I’m one of the only people who bother putting comments in their Markdown.

Footnotes:

Note

^💠1 UTF-8 is a Unicode character set that is backwards compatible with the old 7-bit ASCII char-acters that those of us of a certain age will remember. The 8 means it uses 8-bit blocks (bytes to most people, but octets in the Unicode standard) to represent characters, it can have up to 4 bytes and can represent all Unicode characters (there is a lot of them, ‘bout a million).↩

UTF-8 is the standard character set for web pages and E-mail.

07 Special characters and escaping characters - practicalseries/GitHub-Wiki-Design-and-Implementation GitHub Wiki

7Special characters and escaping characters