You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/myst-reference.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,7 +99,7 @@ Use [Shimmer](http://example.com) for cleaner whiter teeth.
99
99
Use [Shimmer](http://example.com) for cleaner whiter teeth.
100
100
101
101
102
-
####Images and figures
102
+
### Images and figures
103
103
104
104
[Figures](https://docutils.sourceforge.io/docs/ref/rst/directives.html#figure) allow a caption and legend, whereas [images](https://docutils.sourceforge.io/docs/ref/rst/directives.html#images) do not.
105
105
However we can {ref}`enhance images with cards <enhance-images-label>` to add a caption and more features.
@@ -111,7 +111,7 @@ Use `figure` for diagrams.
111
111
Paths to images and figures must resolve in both the main documentation and the submodule's documentation, if present.
112
112
113
113
114
-
#####Width of media
114
+
#### Width of media
115
115
116
116
The main content area of a page in the documentation is 743 pixels wide.
117
117
When taking screenshots or videos, resize your browser window, or try to limit the width of your media to 740 pixels.
@@ -120,7 +120,7 @@ This will preserve legibility of images.
120
120
121
121
(enhance-images-label)=
122
122
123
-
#####Enhance images
123
+
#### Enhance images
124
124
125
125
We use cards from the Sphinx extension [`sphinx-design`](https://sphinx-design.readthedocs.io/en/latest/cards.html) to enhance the display and functionality of images.
126
126
@@ -149,7 +149,7 @@ _Caching Control Panel_
149
149
````
150
150
151
151
152
-
#####Accessibility with `alt` text
152
+
#### Accessibility with `alt` text
153
153
154
154
From [Web Accessibility In Mind (WebAIM)](https://webaim.org/techniques/alttext/):
155
155
@@ -173,7 +173,7 @@ The following MyST example will display as shown below.
173
173
```
174
174
175
175
176
-
#####Inline images
176
+
#### Inline images
177
177
178
178
For inline images, we use the MyST extension [`html_image`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images).
179
179
Example syntax is shown below.
@@ -231,7 +231,7 @@ The following MyST example will display as shown below.
231
231
```
232
232
233
233
234
-
####Video
234
+
### Video
235
235
236
236
To embed local videos, such as recordings of demonstrating the user interface, we require that the videos be saved as `.mp4` for greatest compatibility, usability, accessibility, and reduced file size.
237
237
@@ -260,7 +260,7 @@ The above MyST markup renders as shown below.
260
260
```
261
261
262
262
263
-
####Diagrams and graphs with Graphviz
263
+
### Diagrams and graphs with Graphviz
264
264
265
265
We use [Graphviz](https://graphviz.org/download/) and its Sphinx extension [`sphinx.ext.graphviz`](https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html) to render diagrams and graph visualizations.
266
266
@@ -293,7 +293,7 @@ The following MyST example will display as shown below.
293
293
```
294
294
295
295
296
-
####Code block
296
+
### Code block
297
297
298
298
A Python code snippet without reStructuredText options, using a simple fence.
299
299
@@ -333,7 +333,7 @@ print("my 1st line")
333
333
print(f"my {a}nd line")
334
334
```
335
335
336
-
####Escape literal backticks inline
336
+
### Escape literal backticks inline
337
337
338
338
```md
339
339
This is MyST syntax for term ``{term}`React` ``
@@ -342,7 +342,7 @@ This is MyST syntax for term ``{term}`React` ``
342
342
This is MyST syntax for term ``{term}`React` ``
343
343
344
344
345
-
####Glossary terms
345
+
### Glossary terms
346
346
347
347
Add a term to the {ref}`glossary-label`, located at {file}`/glossary.md`.
0 commit comments