Writing content
中文English

Markdown content

Content is GitHub-flavored Markdown. Don't repeat the lesson title — it comes from lesson.yaml.

What is supported

  • Tables, task lists, footnotes1
  • Inline math E=mc2E = mc^2 and display math:
Attention(Q,K,V)=softmax(QK⊤dk)V\text{Attention}(Q,K,V) = \mathrm{softmax}\left(\frac{QK^\top}{\sqrt{d_k}}\right)V
  • Fenced code with a language tag (copyable on the page):
def greet(name: str) -> str:
    return f"Hello, {name}!"

Raw HTML boundary

A little HTML is allowed, e.g. a centered image:

Centered example

Figure 1 A centered image

<script>, <iframe>, style attributes and event attributes such as onclick are stripped.

Linking other lessons

Point at the other lesson's content file with a relative path, e.g. IDs and languages. The framework rewrites it to the page URL; a missing target fails the build.

Footnotes

  1. Footnotes render at the bottom of the page. ↩