File tree 1 file changed +33
-0
lines changed
1 file changed +33
-0
lines changed Original file line number Diff line number Diff line change @@ -121,6 +121,39 @@ Remember to clear all outputs on your notebook before uploading it.
121
121
🎉 <b >Wait for review!</b >
122
122
</ul >
123
123
124
+ ### Adding a tutorial thumbnail
125
+
126
+ You may add a thumbnail to the front page of the tutorials site with the
127
+ following procedure:
128
+
129
+ 1 . In ` index.md ` , find the ` panels ` directive for your tutorial's category
130
+ (e.g. ` NumPy Features ` or ` NumPy Applications ` ). The ` panels ` directive
131
+ begins with ````` ````{panels}```` ````` .
132
+ 2 . Add a new card to the bottom of the ` panels ` :
133
+
134
+ ```
135
+ ---
136
+
137
+ {doc}`<path-to-tutorial>`
138
+
139
+ +++
140
+
141
+ <thumbnail_img>
142
+ ```
143
+
144
+ Where ` <path-to-tutorial> ` should be replaced with the path to the tutorial
145
+ (typically ` content/<filename.md> ` ) and <thumbnail_img> should be replaced
146
+ with the image you'd like to use as the thumbnail.
147
+
148
+ This can either be a static image, in which case traditional markdown image
149
+ syntax will work, or a figure generated during the execution of your
150
+ tutorial. In the latter case, use [ the glue feature of myst-nb] [ myst_nb_glue ] .
151
+
152
+ [ myst_nb_glue ] : https://myst-nb.readthedocs.io/en/latest/use/glue.html
153
+
154
+ Don't worry if you get stuck - a reviewer/maintainer can help with the
155
+ process of creating a thumbnail for your tutorial.
156
+
124
157
For more information about GitHub and its workflow, you can see
125
158
[ this document] [ collab ] .
126
159
You can’t perform that action at this time.
0 commit comments