Merge pull request #54 from weber-s/doc_tag_plotly

[DOC] Add plotly_header and plotly_footer in doc Addresses #49
GibbsConsulting · Oct 19, 2018 · 9681f22 · 9681f22
2 parents feabacb + 31d5efb
commit 9681f22
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/docs/template_tags.rst b/docs/template_tags.rst
@@ -70,6 +70,40 @@ This tag should not appear more than once on a page. This rule however is not en
 
 .. _plotly_message_pipe:
 
+
+The ``plotly_header`` and ``plotly_footer`` template tag
+--------------------------------------------------------
+
+``DjangoDash`` allows you to inject directly the html generated by ``Dash`` in
+the DOM of the page (without iframe). To include your app CSS and JS, you have
+to include 2 tags in your template ``plotly_header`` and ``plotly_footer``, as
+folllows:
+
+.. code-block:: jinja
+
+    <!-- templates/base.html -->
+    <!DOCTYPE html>
+    <html>
+        <head>
+        ...
+        {% load plotly_dash%}
+        ...
+        {% plotly_header %}
+        ...
+        </head>
+        <body>
+        ...
+        {%plotly_direct name="SimpleExample"%}
+        ...
+        </body>
+        ...
+        {% plotly_footer %}
+    </html>
+
+This part in mandatory if you want to use ``plotly_direct`` tag.
+
+
+
 The ``plotly_message_pipe`` template tag
 ----------------------------------------