Deployed c8ec533 to develop with MkDocs 1.6.1 and mike 2.1.3

Author: github-actions

develop/about/changelog/index.html

@@ -89,4 +89,4 @@
 <span class=x>    </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>&quot;example_project.my_app.components.hello_world&quot;</span> <span class=nv>recipient</span><span class=o>=</span><span class=s2>&quot;World&quot;</span> <span class=cp>%}</span>
 <span class=x>  &lt;/body&gt;</span>
 <span class=x>&lt;/html&gt;</span>
-</code></pre></div></td></tr></table></div> </div> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 29, 2024</span> </small> </div> <div class=md-source-date> <small> Authors: <span class="git-page-authors git-authors"><a href=mailto:[email protected]>Mark Bakhit</a></span> </small> </div> </article> </div> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> &copy; <div id=year></div> <script>document.getElementById("year").innerHTML = new Date().getFullYear();</script> Reactive Python and affiliates. <div class=legal-footer-right>This project has no affiliation to ReactJS or Meta Platforms, Inc.</div> </div> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "content.code.copy", "search.highlight"], "search": "../../assets/javascripts/workers/search.a264c092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.4e0fa4ba.min.js></script> <script src=../../assets/js/main.js></script> </body> </html>
+</code></pre></div></td></tr></table></div> </div> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="December 29, 2024 10:26:30">December 29, 2024</span> </small> </div> <div class=md-source-date> <small> Authors: <span class="git-page-authors git-authors"><a href=mailto:[email protected]>Mark Bakhit</a></span> </small> </div> </article> </div> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> &copy; <div id=year></div> <script>document.getElementById("year").innerHTML = new Date().getFullYear();</script> Reactive Python and affiliates. <div class=legal-footer-right>This project has no affiliation to ReactJS or Meta Platforms, Inc.</div> </div> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "content.code.copy", "search.highlight"], "search": "../../assets/javascripts/workers/search.a264c092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.4e0fa4ba.min.js></script> <script src=../../assets/js/main.js></script> </body> </html>

develop/about/contributing/index.html

@@ -20,15 +20,15 @@
 <span class=x>    </span><span class=cp>{%</span> <span class=k>component</span> <span class=s2>&quot;example_project.my_app.components.hello_world&quot;</span> <span class=nv>recipient</span><span class=o>=</span><span class=s2>&quot;World&quot;</span> <span class=cp>%}</span>
 <span class=x>  &lt;/body&gt;</span>
 <span class=x>&lt;/html&gt;</span>
-</code></pre></div></td></tr></table></div> </div> </div> </div> <details class=tip open=open> <summary>Components are automatically registered!</summary> <p>ReactPy-Django will automatically register any component that is referenced in a Django HTML template. This means you <a href=../../reference/utils/#register-component>typically</a> do not need to manually register components in your <strong>Django app</strong>.</p> <p>Please note that this HTML template must be properly stored within a registered Django app. ReactPy-Django will output a console log message containing all detected components when the server starts up.</p> </details> <details class=warning> <summary>Do not use context variables for the component path</summary> <p>The ReactPy component finder requires that your component path is a string.</p> <p><strong>Do not</strong> use Django template/context variables for the component path. Failure to follow this warning will result in render failures.</p> <p>For example, <strong>do not</strong> do the following:</p> <div class="tabbed-set tabbed-alternate" data-tabs=3:2><input checked=checked id=__tabbed_3_1 name=__tabbed_3 type=radio><input id=__tabbed_3_2 name=__tabbed_3 type=radio><div class=tabbed-labels><label for=__tabbed_3_1>my_template.html</label><label for=__tabbed_3_2>views.py</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>1</span>
+</code></pre></div></td></tr></table></div> </div> </div> </div> <details class=tip open=open> <summary>Components are automatically registered!</summary> <p>ReactPy-Django will automatically register any component that is referenced in a Django HTML template. This means you typically do not need to <a href=../../reference/utils/#register-component>manually register</a> components in your <strong>Django app</strong>.</p> <p>Please note that this HTML template must be properly stored within a registered Django app. ReactPy-Django will output a console log message containing all detected components when the server starts up.</p> </details> <details class=warning> <summary>Do not use context variables for the component path</summary> <p>The ReactPy component finder requires that your component path is a string.</p> <p><strong>Do not</strong> use Django template/context variables for the component path. Failure to follow this warning will result in render failures.</p> <p>For example, <strong>do not</strong> do the following:</p> <div class="tabbed-set tabbed-alternate" data-tabs=3:2><input checked=checked id=__tabbed_3_1 name=__tabbed_3 type=radio><input id=__tabbed_3_2 name=__tabbed_3 type=radio><div class=tabbed-labels><label for=__tabbed_3_1>my_template.html</label><label for=__tabbed_3_2>views.py</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>1</span>
 <span class=normal>2</span>
 <span class=normal>3</span>
 <span class=normal>4</span>
-<span class=normal>5</span></pre></div></td><td class=code><div><pre><span></span><code><span class=x>&lt;!-- This is good --&gt;</span>
-<span class=cp>{%</span> <span class=k>component</span> <span class=s2>&quot;example_project.my_app.components.hello_world&quot;</span> <span class=nv>recipient</span><span class=o>=</span><span class=s2>&quot;World&quot;</span> <span class=cp>%}</span>
-
-<span class=x>&lt;!-- This is bad --&gt;</span>
+<span class=normal>5</span></pre></div></td><td class=code><div><pre><span></span><code><span class=x>&lt;!-- This is bad --&gt;</span>
 <span class=cp>{%</span> <span class=k>component</span> <span class=nv>my_variable</span> <span class=nv>recipient</span><span class=o>=</span><span class=s2>&quot;World&quot;</span> <span class=cp>%}</span>
+
+<span class=x>&lt;!-- This is good --&gt;</span>
+<span class=cp>{%</span> <span class=k>component</span> <span class=s2>&quot;example_project.my_app.components.hello_world&quot;</span> <span class=nv>recipient</span><span class=o>=</span><span class=s2>&quot;World&quot;</span> <span class=cp>%}</span>
 </code></pre></div></td></tr></table></div> </div> <div class=tabbed-block> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>1</span>
 <span class=normal>2</span>
 <span class=normal>3</span>
@@ -86,4 +86,4 @@
     <span class=n>path</span><span class=p>(</span><span class=s2>&quot;example/&quot;</span><span class=p>,</span> <span class=n>views</span><span class=o>.</span><span class=n>index</span><span class=p>),</span>
 <span class=p>]</span>
 </code></pre></div></td></tr></table></div> </div> </div> </div> <details class=question> <summary>Which urls.py do I add my views to?</summary> <p>For simple <strong>Django projects</strong>, you can easily add all of your views directly into the <strong>Django project's</strong> <code>urls.py</code>. However, as you start increase your project's complexity you might end up with way too much within one file.</p> <p>Once you reach that point, we recommend creating an individual <code>urls.py</code> within each of your <strong>Django apps</strong>.</p> <p>Then, within your <strong>Django project's</strong> <code>urls.py</code> you will use Django's <a href=https://docs.djangoproject.com/en/stable/ref/urls/#include><code>include</code> function</a> to link it all together.</p> </details> <h2 id=viewing-your-component>Viewing your component<a class=headerlink href=#viewing-your-component title="Permanent link">&para;</a></h2> <p>To test your new Django view, run the following command to start up a development web server.</p> <div class=highlight><pre><span></span><code>python<span class=w> </span>manage.py<span class=w> </span>runserver
-</code></pre></div> <p>Now you can navigate to your <strong>Django project</strong> URL that contains a ReactPy component, such as <a href=http://127.0.0.1:8000/example/ ><code>http://127.0.0.1:8000/example/</code></a> (<a href=#setting-up-a-django-view><em>from the previous step</em></a>).</p> <p>If you copy-pasted our example component, you will now see your component display "Hello World".</p> <details class=warning> <summary>Do not use <code>manage.py runserver</code> for production</summary> <p>This command is only intended for development purposes. For production deployments make sure to read <a href=https://docs.djangoproject.com/en/stable/howto/deployment/ >Django's documentation</a>.</p> </details> <h2 id=learn-more>Learn more<a class=headerlink href=#learn-more title="Permanent link">&para;</a></h2> <p><strong>Congratulations!</strong> If you followed the previous steps, you have now created a "Hello World" component using ReactPy-Django!</p> <div class="admonition info"> <p class=admonition-title>Deep Dive</p> <p>The docs you are reading only covers our Django integration. To learn more, check out one of the following links:</p> <ul> <li><a href=../../reference/components/ >ReactPy-Django Feature Reference</a></li> <li><a href=https://reactpy.dev/docs/guides/creating-interfaces/index.html>ReactPy Core Documentation</a></li> <li><a href=https://discord.gg/uNb5P4hA9X>Ask Questions on Discord</a></li> </ul> <p>Additionally, the vast majority of tutorials/guides you find for ReactJS can be applied to ReactPy.</p> </div> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 2, 2024</span> </small> </div> <div class=md-source-date> <small> Authors: <span class="git-page-authors git-authors"><a href=mailto:[email protected]>Mark Bakhit</a></span> </small> </div> </article> </div> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> &copy; <div id=year></div> <script>document.getElementById("year").innerHTML = new Date().getFullYear();</script> Reactive Python and affiliates. <div class=legal-footer-right>This project has no affiliation to ReactJS or Meta Platforms, Inc.</div> </div> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "content.code.copy", "search.highlight"], "search": "../../assets/javascripts/workers/search.a264c092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.4e0fa4ba.min.js></script> <script src=../../assets/js/main.js></script> </body> </html>
+</code></pre></div> <p>Now you can navigate to your <strong>Django project</strong> URL that contains a ReactPy component, such as <a href=http://127.0.0.1:8000/example/ ><code>http://127.0.0.1:8000/example/</code></a> (<a href=#setting-up-a-django-view><em>from the previous step</em></a>).</p> <p>If you copy-pasted our example component, you will now see your component display "Hello World".</p> <details class=warning> <summary>Do not use <code>manage.py runserver</code> for production</summary> <p>This command is only intended for development purposes. For production deployments make sure to read <a href=https://docs.djangoproject.com/en/stable/howto/deployment/ >Django's documentation</a>.</p> </details> <h2 id=learn-more>Learn more<a class=headerlink href=#learn-more title="Permanent link">&para;</a></h2> <p><strong>Congratulations!</strong> If you followed the previous steps, you have now created a "Hello World" component using ReactPy-Django!</p> <div class="admonition info"> <p class=admonition-title>Deep Dive</p> <p>The docs you are reading only covers our Django integration. To learn more, check out one of the following links:</p> <ul> <li><a href=../../reference/components/ >ReactPy-Django Feature Reference</a></li> <li><a href=https://reactpy.dev/docs/guides/creating-interfaces/index.html>ReactPy Core Documentation</a></li> <li><a href=https://discord.gg/uNb5P4hA9X>Ask Questions on Discord</a></li> </ul> <p>Additionally, the vast majority of tutorials/guides you find for ReactJS can be applied to ReactPy.</p> </div> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="March 14, 2025 01:11:54">March 14, 2025</span> </small> </div> <div class=md-source-date> <small> Authors: <span class="git-page-authors git-authors"><a href=mailto:[email protected]>Mark Bakhit</a></span> </small> </div> </article> </div> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> &copy; <div id=year></div> <script>document.getElementById("year").innerHTML = new Date().getFullYear();</script> Reactive Python and affiliates. <div class=legal-footer-right>This project has no affiliation to ReactJS or Meta Platforms, Inc.</div> </div> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "content.code.copy", "search.highlight"], "search": "../../assets/javascripts/workers/search.a264c092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.4e0fa4ba.min.js></script> <script src=../../assets/js/main.js></script> </body> </html>