Section 1
General Formatting
GitHub Markdown syntax are supported including extras such as Markdown Math.
Supported Header Tags
Header tags from h1
to h6
are supported.
Though <h1>
is the largest, it is recommended that you should start with <h2>
for main general headings.
Bolded h4
through h6
These levels the fonts are bolded. Because of their smaller sizes, the bold type will make them stand out.
Special h6
Last header is special, <h6>
has a dark theme.
Quotations
Quotations begin with a >
. To add a line-break use <br/>
.
Thus conscience does make cowards of us all.
— Shakespeare
Space them between a blank line to add a small gap:
As the death-bed whereon it must expire
Consumed with that which it was nourish’d by.
This thou perceivest, which makes thy love more strong,
To love that well which thou must leave ere long.
Definition Lists
- Definition List
-
Use
<dl>
for lists without bullet or numbers<dt>
for term or name of the definition.<dd>
for definition. - Ordered Lists
-
Use a number followed by a period (
1.
) to make ordered lists (see below). - Unordered Lists
-
Use a
-
or*
to make unordered lists. These types can be mixed.
Bullet and Number Lists
Sample
- Bullets begin either with a
-
or a*
- Child bullets are indented aligned to the character after the space
- Subsequent bullets are aligned the same way
- 4th level bullet
- Subsequent bullets are aligned the same way
- You can mix numbered lists under a bullet
- This line has a prefix
1.
- This is a
-
- This is a
1.
- This is a
2.
- This is a
- This is a
- This line has a prefix
- Child bullets are indented aligned to the character after the space
-
Numbered list
To separate from above list, place an empty line in between.
-
With child lists
Align blocks texts by indentation to the first character after the space.
- This line starts with a
-
-
This line starts with a
1.
Note that it changes to a lowered-case character
- Greek alpha under numbered
- Second alpha
-
Second enumerated alpha
Quotation
-
Back to bullet
- code block
- This line starts with a
This Course Overview
- Segment 1: Theme’s Overview
- Session 1: Syllabus & Course Overview
- Session 2: AskClass Course Theme Intro
- Assignment 1
- Due Oct 7
- Get AskClass Course Theme Running
part 1
- Segment 2: Diving Deeper
- Session 3: Formatting Content (this page)
- Assigment 2
- Due Oct 16
- Hosting Your Page on GitHub
part 2
- Quiz
- Due Oct 17
- Seek Knowledge & Gain Wisdom
- Segment 3: Conversations
- Making Conversations
- Continuing the Dialog
Section 2
Special Formatting
Below are special formatting for AskClass Course Theme only.
Hiding Texts
Use <samp>
to hide text.
Separator Lines
We support ----
for separators but also have 2 additional special classes: section
and logo
.
Section Separator
<hr class="section" />
Using the above code will create an ornate separator as you see between sections 1 & 2 above.
Logo Separator
<hr class="logo" />
Similar to above separator but places your logo in the center.
You can customize this image by modifying _sass/init.scss
:
$icon-logo: url('/assets/logo-icon.svg');
Poems
Use <dl class='poem'>
for poetry.
The definition will have a hanging indentation like example below.
Note: You need to make the screen narrower to see the hanging indentation.
- Hamlet, Act III, Scene I
- To sleep: perchance to dream: ay, there's the rub;
- For in that sleep of death what dreams may come
- When we have shuffled off this mortal coil,
- Must give us pause: there's the respect
- That makes calamity of so long life;
Blocks of Texts
Normal code block will not wrap white-space
.
<html>
<head>
<title>AskClass Theme</title>
</head>
<body>
Welcome friend!
</body>
</html>
If you want to wrap white-space
use <pre>
:
In me thou see’st the glowing of such fire \ That on the ashes of his youth doth lie, \ As the death-bed whereon it must expire \ Consumed with that which it was nourish’d by.