This page has two audiences. Students: it explains why the notes look the way they do. Teachers: it is a working reference for everything you can put in a page, with the source shown beside every example.

Everything below is written in Markdown β€” plain text with a few marks of punctuation that mean something. If you can write a text message, you can write this.


Text that carries meaning

You get bold, italic, struck through, and highlighted text. Highlighting is the one worth knowing: it catches the eye better than bold when a single limiting reagent has to stand out inside a paragraph.

How that was made:

**bold**, *italic*, ~~struck through~~, ==highlighted==

Arrows written as -> become proper arrows: reactants β†’ products β†’ evidence.

Keyboard keys look like keys: press ⌘ + K to search.


Headings, and the table of contents

Every ## heading becomes a link in Navigate this page, over on the right. Nothing builds that list by hand β€” it is assembled from the headings as the page is built, so it can never fall out of step with the page it describes.

Deeper headings nest underneath: a ### sits inside the ## above it.

How that was made: ## at the start of a line, and ### for a sub-heading.

## Callouts
 
### Foldable callouts

Write headings for the person skimming

The table of contents is the first thing many students read. β€œSubtraction is where precision goes to die” tells them what is there; β€œMore on this” does not.

Turning it off

A short page, or one that is mostly a list, reads better without a contents panel. One line in the frontmatter:

---
enableToc: false
---

Every class page in All Classes uses this. Open Unit 1, Day 1 and there is no β€œNavigate this page” panel, even though the page has headings that would otherwise appear there β€” an agenda of six items does not need navigating.


Callouts

Callouts lift something out of the flow of the page. There are a dozen kinds, each with its own colour and icon, so students learn to recognise them at a glance.

Note

Neutral information worth setting apart.

Tip

A shortcut, a habit, or something that makes the work easier.

Important

The one thing to take away if you take away nothing else.

Warning

Where people usually go wrong.

Safety

Used in this course only for physical safety in the lab.

Question

Something to think about rather than something to know.

Example

A worked case.

At a glance

Used at the top of task pages for the format and what is due.

How that was made: a blockquote with the kind named in brackets.

> [!warning] Where people usually go wrong
> 
> The text of the callout goes here.

Foldable callouts

Add a - after the kind and the callout starts collapsed. Clicking the title opens it. This is how answers, hints, and worked solutions stay on the page without giving themselves away.

How that was made: the - after the kind is the whole difference.

> [!success]- Answer: how many moles in 4.6 g?
> 
> The hidden content.

Mathematics and chemistry

Inline maths sits inside a sentence: a solution of concentration in a volume contains .

Display maths gets a line of its own, centred:

Chemistry is written inside \ce{...}. Everything in there is read as chemistry, so subscripts sit low, charges sit high, states sit in brackets, and reaction arrows are arrows rather than a hyphen and a greater-than sign:

Ions carry their charge properly β€” sulfate is and ammonium is β€” which matters, because and are different substances and the difference is one character.

Multi-step working goes on a single line, aligned on the equals signs:

How that was made: single dollar signs keep it in the sentence, double ones give it a line of its own.

Inline: $c = 0.100\ \text{mol/L}$
 
Display: $$\ce{CH4 + 2O2 -> CO2 + 2H2O}$$

Writing chemistry with \ce{}

Everything chemical on this site is typed inside \ce{}, and it is worth ten minutes once. You type roughly what you would say aloud; it works out which digits are subscripts, which are coefficients, and where the spacing goes.

What you typeWhat appearsWhat it means
$\ce{H2O}$Digits drop to subscripts
$\ce{2H2O}$A digit in front is a coefficient
$\ce{SO4^2-}$A charge, number before sign
$\ce{Ca(OH)2}$Brackets as you write them
$\ce{CaCO3(s)}$A state, typed literally
$\ce{2H2 + O2 -> 2H2O}$The reaction arrow
$\ce{CaCO3(s) <=> CaO(s) + CO2(g)}$The equilibrium arrow
$\ce{CuSO4 * 5H2O}$The dot in a hydrate
$\ce{AgCl v}$Precipitate down, gas up
$\ce{Zn^2+ + 2e- -> Zn}$Electrons behave like ions
$\ce{->[heat]}$A condition above the arrow

Two habits worth keeping:

  • Anything chemical goes inside \ce{}, including a formula in the middle of a sentence, like . Outside it, H_2O comes out in maths italic β€” the convention for variables, which reads wrongly for an element.
  • A display equation stays on one physical line. A $$ span broken across lines, indented four spaces, or spread down a callout hits a markdown seam and shatters.

Diagrams

Diagrams are written, not drawn β€” which means they can be edited in seconds, they never need a graphics program, and a change to one shows up in a diff.

Flowchart

graph LR
    A["Question"] --> B["Prediction with a mechanism"]
    B --> C["Design and run it"]
    C --> D["Data, with units"]
    D --> E{"Is the difference bigger than the uncertainty?"}
    E -->|yes| F["State it, with limitations"]
    E -->|no| G["One result, measured twice"]

How that was made: not a picture β€” these lines of text, between two fence lines that say mermaid.

```mermaid
graph LR
    A["Question"] --> B["Prediction with a mechanism"]
    B --> C["Design and run it"]
    C --> D["Data, with units"]
```

--> draws an arrow, ["…"] makes a box, {"…"} makes a decision diamond, and -->|yes| labels the arrow. Change a word and the diagram redraws.

Processes

graph TD
    M["Mass, in grams"] -->|divide by molar mass| N["Amount, in moles"]
    N -->|mole ratio from the equation| N2["Moles of product"]
    N2 -->|multiply by molar mass| M2["Mass of product"]

That diagram is the whole of Stoichiometry in four boxes, which is roughly the point of drawing it.

Proportions

pie title Dry air, by volume
    "Nitrogen" : 78
    "Oxygen" : 21
    "Argon and everything else" : 1

Carbon dioxide is inside that last sliver.1


Tables

How that was made: rows of text separated by |, with a line of dashes under the headings.

QuantitySymbolUnitWhere it turns up
Amount of substancemole (mol)the counting unit
Molar massgrams per mole (g/mol)Molar Mass and Composition
Concentrationmoles per litre (mol/L)Concentration

Maths works inside table cells, and so do links β€” which matters more than it sounds, because it means a summary table can be a navigation aid rather than a dead end.

For teachers: escape the pipe inside a table cell

A wikilink with different display words uses a pipe, and so does the table. Inside a table cell, write [[The Mole\|the counting unit]] with a backslash, or the row splits into an extra column.


Checklists

How that was made: a list where each line starts with - [ ], or - [x] for one already done.

  • Eye protection on
  • Procedure checked by the teacher
  • Prediction written down before measuring
  • Waste route confirmed
  • Station cleaned

On the site they are read-only β€” the boxes show what the page says, and clicking one does nothing. Copied into a notebook, they are useful for keeping your place during a lab.


Code

How that was made: three backticks and the name of a language, the code, then three backticks to close it.

```python
def moles(mass_in_grams, molar_mass):
    return mass_in_grams / molar_mass
```
def moles(mass_in_grams, molar_mass):
    return mass_in_grams / molar_mass
 
print(round(moles(2.46, 58.44), 4), "mol")

Syntax colouring follows the language you name after the opening fence and adapts to light or dark mode. This course does not ask you to write any code β€” it is here because the site supports it, and a teacher adapting these pages for a computer science course will want to know.


This is what makes the site more than a pile of documents.

How that was made: double square brackets.

[[The Mole]]
[[The Mole|different words for the link]]
[[The Mole#why-this-is-the-hinge-of-the-course|Why this is the hinge of the course]]

Transclusion β€” one page inside another

How that was made: ![[Page name]] β€” a link with an exclamation mark in front of it. Below, the help-session times are pulled in live rather than copied:

Help Sessions

Extra help

WhenWhere
Monday, lunchThe chemistry room
Wednesday, after school until 4:15The chemistry room

Drop in β€” no appointment, no need to tell me first. Bring the specific thing you are stuck on: one stoichiometry question that will not come out beats β€œthe mole”. Lab write-ups count too, and so does a result that did not do what you expected β€” that is usually the most interesting conversation of the week.

Nothing gets set up, heated, or poured at lunch without me in the room.

More: Getting Help

Link to original

Change the source page and every page that embeds it updates. That is how a section landing page always shows the current class agenda without anybody maintaining a second copy of it. It is also how the curriculum expectations appear at the foot of a concept page β€” the wording lives in one file and is quoted everywhere it applies.

Scroll to the bottom of any page and you will find Backlinks β€” every page that links to this one, gathered automatically. Nobody maintains that list, which is why linking generously costs nothing and pays off later.


Hover previews

Hover over Polyatomic Ions without clicking. The page appears in a small window. A student checking one formula mid-calculation does not lose their place β€” which, in a course with this much looking-up in it, is the feature they will use most.


Footnotes

How that was made: [^1] where the marker goes, and a matching [^1]: line anywhere in the page.


Tags

How that was made: a tags list in the frontmatter at the very top of the page.

---
tags:
  - quantities
  - safety
---

Every tag becomes a page listing everything filed under it.


What you cannot see

Two things on this page are invisible in the browser:

  1. Comments. Text wrapped in β€œ never reaches the site. Useful for notes to yourself in a page you are still writing.
  2. Holding a page back. A page with publish: false in its frontmatter is skipped entirely when the site is built. Write next week’s lesson today and publish it when you are ready.

For teachers reading this

A shared page can also be published to one section and held back from another: look at the top of this page’s source and you will find a createdSection1 / publishForSection1 pair for each of your sections. Set one section’s key to false and the page waits for that class β€” useful when your two classes have drifted a few days apart and one of them has not done the titration yet.


The point of all this

None of it is decoration. Each feature removes a reason for a page to go out of date:

FeatureThe problem it solves
TransclusionThe same text copied into six places, five of them stale
Backlinks”Where did we use this again?”
Diagrams as textRebuilding a whole diagram to change one arrow
Holding a page backKeeping unpublished work in some other file somewhere
Typeset chemistryScreenshotting equations out of a document
Hover previewsLosing your place to check one polyatomic ion

Write it once, link to it everywhere.

Footnotes

  1. Carbon dioxide makes up well under a tenth of one percent of dry air by volume, which is why it does not get its own slice above. Its effect on the planet’s energy balance is out of all proportion to that share β€” the reason being part of what Gases and the Atmosphere is for. ↩