diff --git a/docs/index.rst b/docs/index.rst index 81cf5ea..436dffe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,6 +37,7 @@ Notes :caption: Some useful notes on aspects of using the library on_meta_dot_json + markdown_1 making_links_to_existing_content wishlist unit_tests diff --git a/docs/markdown_1.rst b/docs/markdown_1.rst new file mode 100644 index 0000000..e8cd02d --- /dev/null +++ b/docs/markdown_1.rst @@ -0,0 +1,5 @@ +Making sure markdown renders when there is a
+=================================================== + +Any time you have a "
" (in a header, footer, body, etc.) make sure that the option markdown="1" is included. +Otherwise, markdown will not render properly on Canvas. \ No newline at end of file diff --git a/docs/tutorials/styling_content.rst b/docs/tutorials/styling_content.rst index 9e2d77c..c77c368 100644 --- a/docs/tutorials/styling_content.rst +++ b/docs/tutorials/styling_content.rst @@ -39,10 +39,14 @@ I hope they're self-documenting in purpose and content. Here's what's in the `h -
+
+ +Note the markdown="1" included in the
above. Any time you include a
, make sure that this appears. +Otherwise, markdown will not render. + The footer simply closes the `div` I opened in the header: .. code-block:: html