Skip to content

Commit 4d27c51

Browse files
committed
Dedent to proper levels
1 parent c009627 commit 4d27c51

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/contributing/myst-reference.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Use [Shimmer](http://example.com) for cleaner whiter teeth.
9999
Use [Shimmer](http://example.com) for cleaner whiter teeth.
100100

101101

102-
#### Images and figures
102+
### Images and figures
103103

104104
[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.
105105
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.
111111
Paths to images and figures must resolve in both the main documentation and the submodule's documentation, if present.
112112

113113

114-
##### Width of media
114+
#### Width of media
115115

116116
The main content area of a page in the documentation is 743 pixels wide.
117117
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.
120120

121121
(enhance-images-label)=
122122

123-
##### Enhance images
123+
#### Enhance images
124124

125125
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.
126126

@@ -149,7 +149,7 @@ _Caching Control Panel_
149149
````
150150

151151

152-
##### Accessibility with `alt` text
152+
#### Accessibility with `alt` text
153153

154154
From [Web Accessibility In Mind (WebAIM)](https://webaim.org/techniques/alttext/):
155155

@@ -173,7 +173,7 @@ The following MyST example will display as shown below.
173173
```
174174

175175

176-
##### Inline images
176+
#### Inline images
177177

178178
For inline images, we use the MyST extension [`html_image`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images).
179179
Example syntax is shown below.
@@ -231,7 +231,7 @@ The following MyST example will display as shown below.
231231
```
232232

233233

234-
#### Video
234+
### Video
235235

236236
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.
237237

@@ -260,7 +260,7 @@ The above MyST markup renders as shown below.
260260
```
261261

262262

263-
#### Diagrams and graphs with Graphviz
263+
### Diagrams and graphs with Graphviz
264264

265265
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.
266266

@@ -293,7 +293,7 @@ The following MyST example will display as shown below.
293293
```
294294

295295

296-
#### Code block
296+
### Code block
297297

298298
A Python code snippet without reStructuredText options, using a simple fence.
299299

@@ -333,7 +333,7 @@ print("my 1st line")
333333
print(f"my {a}nd line")
334334
```
335335

336-
#### Escape literal backticks inline
336+
### Escape literal backticks inline
337337

338338
```md
339339
This is MyST syntax for term ``{term}`React` ``
@@ -342,7 +342,7 @@ This is MyST syntax for term ``{term}`React` ``
342342
This is MyST syntax for term ``{term}`React` ``
343343

344344

345-
#### Glossary terms
345+
### Glossary terms
346346

347347
Add a term to the {ref}`glossary-label`, located at {file}`/glossary.md`.
348348

0 commit comments

Comments
 (0)