Contribution Guide & Page Template
Follow the structure below to ensure your contribution is formatted correctly. Use this file as a template for new chapter notes.
1. Chapter Sections
Each major topic should be wrapped in a
<section>
tag with a unique ID. The section title
uses an <h2>
tag.
2. Explanation Blocks
The core content uses the "explanation block" format. This consists of two parts: the original text from the book and your explanatory notes.
Use a <p>
tag with a
<strong>
tag for the sub-heading.
This <p>
tag with the class
original-text
contains the direct quote from the
source material. Use <em>
tags to italicize
it.
This <div>
with the class
explanation-text
holds your notes and analysis. You
can use standard HTML tags here like
strong for bold,
code for inline code
, and links.
3. Code Blocks
For code blocks, use the <pre>
and
<code>
tags. Add a language-
class
to the <code>
tag for syntax highlighting.
4. Math and Equations
For mathematical notation, use LaTeX syntax.
- For inline math, wrap the expression in single dollar signs, like $E = mc^2$.
- For block-level equations, wrap the expression in double dollar signs:
5. Images and Figures
To include an image with a caption, use the
<figure>
and
<figcaption>
tags.
