Docs related to markdown="1"

ofloveandhate · Jul 24, 2024 · ee6301f · ee6301f
1 parent a1399d6
commit ee6301f
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git 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
@@ -0,0 +1,5 @@
+Making sure markdown renders when there is a <div>
+===================================================
+
+Any time you have a "<div>" (in a header, footer, body, etc.) make sure that the option markdown="1" is included. 
+Otherwise, markdown will not render properly on Canvas.
diff --git 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
    <script href="https://media.uwex.edu/app/droplets_v3/script/droplets.js" type="test/javascript"></script>
 
 
-   <div id="uws-droplets-page">
+   <div id="uws-droplets-page" markdown="1">
 
    <!-- Droplets elements and components -->
 
+
+Note the markdown="1" included in the <div> above. Any time you include a <div>, make sure that this appears. 
+Otherwise, markdown will not render.
+
 The footer simply closes the `div` I opened in the header:
 
 .. code-block:: html