thibaud frere
commited on
Commit
·
505ef8e
1
Parent(s):
941cf22
update doc
Browse files
app/src/content/chapters/available-blocks.mdx
CHANGED
|
@@ -16,10 +16,10 @@ import ResponsiveImage from '../../components/ResponsiveImage.astro';
|
|
| 16 |
<br/>
|
| 17 |
<div className="button-group">
|
| 18 |
<a className="button" href="#math">Math</a>
|
| 19 |
-
<a className="button" href="#responsiveimage">ResponsiveImage</a>
|
| 20 |
<a className="button" href="#code-blocks">Code</a>
|
| 21 |
-
<a className="button" href="#mermaid-diagrams">Mermaid</a>
|
| 22 |
<a className="button" href="#citations-and-notes">Citations & notes</a>
|
|
|
|
|
|
|
| 23 |
<a className="button" href="#placement">Placement</a>
|
| 24 |
<a className="button" href="#accordion">Accordion</a>
|
| 25 |
<a className="button" href="#note">Note</a>
|
|
@@ -55,6 +55,56 @@ $$
|
|
| 55 |
$$
|
| 56 |
```
|
| 57 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
### ResponsiveImage
|
| 59 |
|
| 60 |
**Responsive images** automatically generate an optimized `srcset` and `sizes` so the browser downloads the most appropriate file for the current viewport and DPR. You can also request multiple output formats (e.g., **AVIF**, **WebP**, fallback **PNG/JPEG**) and control **lazy loading/decoding** for better **performance**.
|
|
@@ -95,26 +145,6 @@ import myImage from './assets/images/placeholder.jpg'
|
|
| 95 |
```
|
| 96 |
|
| 97 |
|
| 98 |
-
### Code
|
| 99 |
-
|
| 100 |
-
Use fenced code blocks with a language for syntax highlighting.
|
| 101 |
-
|
| 102 |
-
```python
|
| 103 |
-
def greet(name: str) -> None:
|
| 104 |
-
print(f"Hello, {name}!")
|
| 105 |
-
|
| 106 |
-
greet("Astro")
|
| 107 |
-
```
|
| 108 |
-
|
| 109 |
-
<small className="muted">Example</small>
|
| 110 |
-
````mdx
|
| 111 |
-
```python
|
| 112 |
-
def greet(name: str) -> None:
|
| 113 |
-
print(f"Hello, {name}!")
|
| 114 |
-
|
| 115 |
-
greet("Astro")
|
| 116 |
-
```
|
| 117 |
-
````
|
| 118 |
|
| 119 |
### Mermaid diagram
|
| 120 |
|
|
@@ -190,32 +220,6 @@ erDiagram
|
|
| 190 |
```
|
| 191 |
````
|
| 192 |
|
| 193 |
-
### Citation and footnote
|
| 194 |
-
|
| 195 |
-
**Citations** use the `@` syntax (e.g., `[@vaswani2017attention]` or `@vaswani2017attention` in narrative form) and are **automatically** collected to render the **bibliography** at the end of the article. The citation keys come from `app/src/content/bibliography.bib`.
|
| 196 |
-
|
| 197 |
-
**Footnotes** use an identifier like `[^f1]` and a definition anywhere in the document, e.g., `[^f1]: Your explanation`. They are **numbered** and **listed automatically** at the end of the article.
|
| 198 |
-
|
| 199 |
-
Here are a few variations using the same bibliography:
|
| 200 |
-
|
| 201 |
-
1) **In-text citation** with brackets: [@example2023].
|
| 202 |
-
|
| 203 |
-
2) **Narrative citation**: As shown by @vaswani2017attention, transformers enable efficient sequence modeling.
|
| 204 |
-
|
| 205 |
-
3) **Multiple citations** and a **footnote** together: see [@vaswani2017attention; @example2023] for related work. Also note this footnote[^f1].
|
| 206 |
-
|
| 207 |
-
[^f1]: Footnote attached to the sentence above.
|
| 208 |
-
|
| 209 |
-
<small className="muted">Example</small>
|
| 210 |
-
```mdx
|
| 211 |
-
1) In-text citation with brackets: [@example2023].
|
| 212 |
-
|
| 213 |
-
2) Narrative citation: As shown by @vaswani2017attention, transformers enable efficient sequence modeling.
|
| 214 |
-
|
| 215 |
-
3) Multiple citations and a footnote together: see [@vaswani2017attention; @example2023] for related work. Also note this footnote[^f1].
|
| 216 |
-
|
| 217 |
-
[^f1]: Footnote attached to the sentence above.
|
| 218 |
-
```
|
| 219 |
|
| 220 |
### Separator
|
| 221 |
|
|
|
|
| 16 |
<br/>
|
| 17 |
<div className="button-group">
|
| 18 |
<a className="button" href="#math">Math</a>
|
|
|
|
| 19 |
<a className="button" href="#code-blocks">Code</a>
|
|
|
|
| 20 |
<a className="button" href="#citations-and-notes">Citations & notes</a>
|
| 21 |
+
<a className="button" href="#responsiveimage">ResponsiveImage</a>
|
| 22 |
+
<a className="button" href="#mermaid-diagrams">Mermaid</a>
|
| 23 |
<a className="button" href="#placement">Placement</a>
|
| 24 |
<a className="button" href="#accordion">Accordion</a>
|
| 25 |
<a className="button" href="#note">Note</a>
|
|
|
|
| 55 |
$$
|
| 56 |
```
|
| 57 |
|
| 58 |
+
### Code
|
| 59 |
+
|
| 60 |
+
Use fenced code blocks with a language for syntax highlighting.
|
| 61 |
+
|
| 62 |
+
```python
|
| 63 |
+
def greet(name: str) -> None:
|
| 64 |
+
print(f"Hello, {name}!")
|
| 65 |
+
|
| 66 |
+
greet("Astro")
|
| 67 |
+
```
|
| 68 |
+
|
| 69 |
+
<small className="muted">Example</small>
|
| 70 |
+
````mdx
|
| 71 |
+
```python
|
| 72 |
+
def greet(name: str) -> None:
|
| 73 |
+
print(f"Hello, {name}!")
|
| 74 |
+
|
| 75 |
+
greet("Astro")
|
| 76 |
+
```
|
| 77 |
+
````
|
| 78 |
+
|
| 79 |
+
|
| 80 |
+
### Citation and footnote
|
| 81 |
+
|
| 82 |
+
**Citations** use the `@` syntax (e.g., `[@vaswani2017attention]` or `@vaswani2017attention` in narrative form) and are **automatically** collected to render the **bibliography** at the end of the article. The citation keys come from `app/src/content/bibliography.bib`.
|
| 83 |
+
|
| 84 |
+
**Footnotes** use an identifier like `[^f1]` and a definition anywhere in the document, e.g., `[^f1]: Your explanation`. They are **numbered** and **listed automatically** at the end of the article.
|
| 85 |
+
|
| 86 |
+
Here are a few variations using the same bibliography:
|
| 87 |
+
|
| 88 |
+
1) **In-text citation** with brackets: [@example2023].
|
| 89 |
+
|
| 90 |
+
2) **Narrative citation**: As shown by @vaswani2017attention, transformers enable efficient sequence modeling.
|
| 91 |
+
|
| 92 |
+
3) **Multiple citations** and a **footnote** together: see [@vaswani2017attention; @example2023] for related work. Also note this footnote[^f1].
|
| 93 |
+
|
| 94 |
+
[^f1]: Footnote attached to the sentence above.
|
| 95 |
+
|
| 96 |
+
<small className="muted">Example</small>
|
| 97 |
+
```mdx
|
| 98 |
+
1) In-text citation with brackets: [@example2023].
|
| 99 |
+
|
| 100 |
+
2) Narrative citation: As shown by @vaswani2017attention, transformers enable efficient sequence modeling.
|
| 101 |
+
|
| 102 |
+
3) Multiple citations and a footnote together: see [@vaswani2017attention; @example2023] for related work. Also note this footnote[^f1].
|
| 103 |
+
|
| 104 |
+
[^f1]: Footnote attached to the sentence above.
|
| 105 |
+
```
|
| 106 |
+
|
| 107 |
+
|
| 108 |
### ResponsiveImage
|
| 109 |
|
| 110 |
**Responsive images** automatically generate an optimized `srcset` and `sizes` so the browser downloads the most appropriate file for the current viewport and DPR. You can also request multiple output formats (e.g., **AVIF**, **WebP**, fallback **PNG/JPEG**) and control **lazy loading/decoding** for better **performance**.
|
|
|
|
| 145 |
```
|
| 146 |
|
| 147 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 148 |
|
| 149 |
### Mermaid diagram
|
| 150 |
|
|
|
|
| 220 |
```
|
| 221 |
````
|
| 222 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 223 |
|
| 224 |
### Separator
|
| 225 |
|