Compare versions

--- Base version+++ Proposed version@@ -1,4 +1,4 @@-## A note you can reuse {#sec:start}+## A note you can reuse {@sec:start}  This is a working template for Peerpedia. It shows what a published note can contain and how another reader can help improve it. The mathematics is elementary so that you can concentrate on the writing tools. @@ -49,25 +49,21 @@ This demo was prepared with AI assistance. It is a guide to the software, not a new research result.  -## Add the first few integers {#sec:sum}+## Add the first few integers {@sec:sum}  Suppose we want the total $1+2+\cdots+n$, where $n$ is a positive integer. Pair the first term with the last. Each pair has the same sum. Writing the list twice, once in each direction, makes the pattern work for odd and even $n$ alike. -Inline mathematics goes between single dollar signs, as in `$n+1$`. A displayed equation goes between double dollar signs. Give it a label when you want to refer to it later.+Inline mathematics goes between single dollar signs, as in `$n+1$`. An unnumbered displayed equation goes between double dollar signs. Use a math code block with a label for a numbered equation you want to refer to later.  ````markdown-::: equation {#eq:sum}-$$+```math {@eq:sum} 1+2+\cdots+n=\frac{n(n+1)}{2}.-$$-:::+``` ```` -::: equation {#eq:sum}-$$+```math {@eq:sum} 1+2+\cdots+n=\frac{n(n+1)}{2}.-$$-:::+```  Equation references stay meaningful when earlier material is inserted. Write `@eq:sum` to produce @eq:sum instead of typing its number yourself. @@ -76,7 +72,7 @@ Theorem and proof blocks separate a claim from its justification.  ```markdown-::: theorem {#thm:sum}+::: theorem {@thm:sum} For every positive integer $n$, the sum of the first $n$ positive integers is $n(n+1)/2$. :::@@ -87,7 +83,7 @@ ::: ``` -::: theorem {#thm:sum}+::: theorem {@thm:sum} For every positive integer $n$, the sum of the first $n$ positive integers is $n(n+1)/2$. ::: @@ -110,7 +106,7 @@ A table can carry a caption and a label too.  ```markdown-::: table Small cases {#tab:sums}+::: example (Table) [Small cases] {@tab:sums} | $n$ | Direct sum | $n(n+1)/2$ | | --- | --- | --- | | 1 | 1 | 1 |@@ -119,7 +115,7 @@ ::: ``` -::: table Small cases {#tab:sums}+::: example (Table) [Small cases] {@tab:sums} | $n$ | Direct sum | $n(n+1)/2$ | | --- | --- | --- | | 1 | 1 | 1 |@@ -130,15 +126,15 @@ The agreement in @tab:sums checks these examples. The proof of @thm:sum is what establishes the formula for every positive integer.  -## Draw a mathematical picture {#sec:diagrams}--A fenced `tikzpicture` block compiles into a drawing. The example below contains five rows of dots. Their lengths are $1,2,3,4,5$, so the picture has fifteen dots, matching @eq:sum with $n=5$.--The surrounding figure block supplies a caption and a reference label.+## Draw a mathematical picture {@sec:diagrams}++A fenced `tikz` block with an explicit `tikzpicture` environment compiles into a drawing. The example below contains five rows of dots. Their lengths are $1,2,3,4,5$, so the picture has fifteen dots, matching @eq:sum with $n=5$.++The surrounding example block uses the custom display name “Figure” and supplies a caption and a reference label.  ````markdown-::: figure Five rows contain fifteen dots {#fig:triangle}-```tikzpicture+::: example (Figure) [Five rows contain fifteen dots] {@fig:triangle}+```tikz \begin{tikzpicture}[scale=0.65] \foreach \row in {1,...,5} {   \foreach \col in {1,...,\row} {@@ -150,8 +146,8 @@ ::: ```` -::: figure Five rows contain fifteen dots {#fig:triangle}-```tikzpicture+::: example (Figure) [Five rows contain fifteen dots] {@fig:triangle}+```tikz \begin{tikzpicture}[scale=0.65] \foreach \row in {1,...,5} {   \foreach \col in {1,...,\row} {@@ -164,14 +160,14 @@  You can link directly to @fig:triangle from another chapter. A new drawing may take a moment to compile. Once it is ready, readers receive the saved result. -## Show two routes with the same result {#sec:commutative}+## Show two routes with the same result {@sec:commutative}  A commutative diagram says that two paths give the same answer. In this example every corner is the integers. Going across multiplies an integer by two. Going down multiplies it by three. Either route from the upper left to the lower right multiplies it by six. -Use a `tikzcd` fence for arrows and their labels.+Use a `tikz` fence with an explicit `tikzcd` environment for arrows and their labels.  ````markdown-```tikzcd+```tikz \begin{tikzcd} \mathbb{Z} \arrow[r, "2"] \arrow[d, "3"'] & \mathbb{Z} \arrow[d, "3"] \\@@ -180,7 +176,7 @@ ``` ```` -```tikzcd+```tikz \begin{tikzcd} \mathbb{Z} \arrow[r, "2"] \arrow[d, "3"'] & \mathbb{Z} \arrow[d, "3"] \\@@ -213,7 +209,7 @@ Keep diagrams self-contained. These blocks do not provide a full LaTeX project or load files from your computer.  -## Help the reader find the exact statement {#sec:links}+## Help the reader find the exact statement {@sec:links}  A label gives a section, equation, theorem, figure, or table a name that the source can refer to. Choose a short descriptive label and use it only once in the whole paper. @@ -225,7 +221,7 @@  The proof in @thm:sum gives @eq:sum. Compare @tab:sums with @fig:triangle. -For a section heading, write `## Your heading {#sec:your-heading}`. You can then refer to it with `@sec:your-heading`. The link @sec:sum is a working example.+For a section heading, write `## Your heading {@sec:your-heading}`. You can then refer to it with `@sec:your-heading`. The link @sec:sum is a working example.  ### Link to another paper @@ -239,17 +235,19 @@  Read the [writing guide](https://peerpedia.dev/help/writing/). -### Cite a source through BibTeX--A bibliography is a shared list of sources for all chapters. In the editor, put the following entry under **References.bib**. When using the CLI, save it in `references.bib` and list that file in `paper.json`.--```bibtex-@misc{peerpediaWriting,-  author = {Peerpedia},-  title = {Writing on Peerpedia},-  year = {2026},-  url = {https://peerpedia.dev/help/writing/}-}+### Cite a source through BananaMark YAML++A bibliography is a shared list of sources for all chapters. In the editor, put the following entry under **Bibliography**. When using the CLI, save it in `references.yaml` and list that file in `paper.json`.++```yaml+peerpediaWriting:+  type: online+  author:+    literal: Peerpedia+  title: Writing on Peerpedia+  site: Peerpedia+  year: 2026+  url: https://peerpedia.dev/help/writing/ ```  Then write this citation in the chapter.@@ -263,7 +261,7 @@ The citation opens the reference entry, which includes a link to the source. Replace this entry with the books, papers, or documents you actually used. Keep the citation keys unique and check that each source supports the statement beside its citation.  -## Suggest a useful change {#sec:contribute}+## Suggest a useful change {@sec:contribute}  A **pull request**, or **PR**, is a proposed change to a published note. It lets readers inspect the new text before the corresponding author accepts it. You can use this process to improve this demo. @@ -293,7 +291,7 @@ This demo does not manufacture comments, ratings, or PRs. Those appear when readers contribute.  -## Download the source {#sec:cli}+## Download the source {@sec:cli}  The CLI is an optional command-line tool for people who prefer their own editor or use an AI coding assistant. You can do all the writing described in the earlier chapters through the website. @@ -328,7 +326,7 @@     {"id": "introduction", "title": "Introduction", "file": "chapters/introduction.md"},     {"id": "examples", "title": "Examples", "file": "chapters/examples.md"}   ],-  "bibliography": "references.bib"+  "bibliography": "references.yaml" } ```