Update Docs (#82)

Update docs
jpsca · Jul 19, 2024 · 63071ec · 63071ec
1 parent 7cf1fcc
commit 63071ec
Show file tree

Hide file tree

Showing 61 changed files with 1,802 additions and 603 deletions.
diff --git a/docs/components/Copyright.jinja b/docs/components/Copyright.jinja
@@ -1,3 +1,4 @@
 <div {{ attrs.render(class="copy") }}>
-  &copy; <a href="https://jpscaletti.com">Juan-Pablo Scaletti</a>
+  Website content copyright &copy; <a href="https://jpscaletti.com">Juan-Pablo Scaletti</a>.
+  JinjaX and its documentation are licensed under the MIT license.
 </div>
diff --git a/docs/components/Home.jinja b/docs/components/Home.jinja
@@ -69,11 +69,11 @@
     <h2>
       Better than <code>include</code> and&nbsp;<code>macros</code>
     </h2>
-    <div class="cards">
+    <div class="cd-cards">
       <article class="card">
         <div class="header">
-          <img src="/static/img/encapsulated.svg" width="32" height="32">
           <h3>Encapsulated</h3>
+          <img src="/static/img/encapsulated.svg" width="32" height="32">
         </div>
         <div class="body prose prose-zinc">
           <div>
@@ -85,8 +85,8 @@
 
       <article class="card">
         <div class="header">
-          <img src="/static/img/simple.svg" width="32" height="32">
           <h3>Simple</h3>
+          <img src="/static/img/simple.svg" width="32" height="32">
         </div>
         <div class="body prose prose-zinc">
           <div>
@@ -98,8 +98,8 @@
 
       <article class="card">
         <div class="header">
-          <img src="/static/img/modern.svg" width="32" height="32">
           <h3>Modern</h3>
+          <img src="/static/img/modern.svg" width="32" height="32">
         </div>
         <div class="body prose prose-zinc">
           <div>
@@ -113,8 +113,8 @@
 
       <article class="card">
         <div class="header">
-          <img src="/static/img/composable.svg" width="32" height="32">
           <h3>Composable</h3>
+          <img src="/static/img/composable.svg" width="32" height="32">
         </div>
         <div class="body prose prose-zinc">
           <div>
@@ -144,7 +144,7 @@
     </div>
   </section>
 
-  <section class="engage">
+  <section class="engage" data-md-skip>
     <div class="wrapper">
       <h3>Ready to get going? Engage!</h3>
       <a href="./guide/">Get started <i>&rarr;</i></a>

diff --git a/docs/components/NavExtra.jinja b/docs/components/NavExtra.jinja
@@ -1,3 +1 @@
-<a title="Source code" href="https://github.com/jpsca/jinjax">
-  {% include "svg/github.svg" %}
-</a>
+<Source title="Go to repo" url="https://github.com/jpsca/jinjax" />
diff --git a/docs/components/ui/Accordion/DemoResult.jinja b/docs/components/ui/Accordion/DemoResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(252,211,77, 0.9), rgba(251,146,60, 0.9))"
+  data-md-skip
 ></div>
 
-<Accordion id="accordion-demo">
+<Accordion id="accordion-demo" data-md-skip>
   <details>
     <summary>Is it accessible?</summary>
     <div class="panel">

diff --git a/docs/components/ui/Dialog/DemoPreview.jinja b/docs/components/ui/Dialog/DemoPreview.jinja
@@ -1,4 +0,0 @@
-<div class="h-96 w-full max-w-xl px-2 py-16 sm:mr-10">
-  <div class="relative w-fit mx-auto">
-  </div>
-</div>

diff --git a/docs/components/ui/LinkedList/DemoResult.jinja b/docs/components/ui/LinkedList/DemoResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(132,204,22,0.7), rgba(22,163,74,0.7))"
+  data-md-skip
 ></div>
 
-<div id="linkedlist-demo">
+<div id="linkedlist-demo" data-md-skip>
   <div>
     <label>Known Mutants</label>
     <LinkedList id="linkedlist-demo-list1" linked_to="linkedlist-demo-list2">

diff --git a/docs/components/ui/Menu/DemoResult.jinja b/docs/components/ui/Menu/DemoResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(244,114,182, 0.9), rgba(219,39,119, 0.9))"
+  data-md-skip
 ></div>
 
-<div id="menu-demo">
+<div id="menu-demo" data-md-skip>
   <MenuButton id="menu-demo-btn" target="menu-demo-menu">
     Menu <i class="icon">keyboard_arrow_down</i>
   </MenuButton>

diff --git a/docs/components/ui/Popover/DemoResult.jinja b/docs/components/ui/Popover/DemoResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(217,70,239, 0.9), rgba(147,51,234, 0.9))"
+  data-md-skip
 ></div>
 
-<div id="pop-demo">
+<div id="pop-demo" data-md-skip>
   <PopButton id="pop-demo-btn" target="pop-demo-pop">Open popover</PopButton>
 
   <Popover id="pop-demo-pop" anchor="pop-demo-btn" anchor-to="bottom">

diff --git a/docs/components/ui/Tabs/DemoResult.jinja b/docs/components/ui/Tabs/DemoResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(56,189,248, 0.9), rgba(37,99,235, 0.9))"
+  data-md-skip
 ></div>
 
-<div class="horizontal-tabs">
+<div class="horizontal-tabs" data-md-skip>
   <TabGroup>
     <TabList>
       <Tab target="demo-recent" selected>Recent</Tab>

diff --git a/docs/components/ui/Tabs/ManualResult.jinja b/docs/components/ui/Tabs/ManualResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(56,189,248, 0.3), rgba(37,99,235, 0.3))"
+  data-md-skip
 ></div>
 
-<div class="horizontal-tabs">
+<div class="horizontal-tabs" data-md-skip>
   <TabGroup>
     <TabList manual>
       <Tab target="manual-recent" selected>Recent</Tab>

diff --git a/docs/components/ui/Tabs/SelectResult.jinja b/docs/components/ui/Tabs/SelectResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(56,189,248, 0.3), rgba(37,99,235, 0.3))"
+  data-md-skip
 ></div>
 
-<div class="horizontal-tabs">
+<div class="horizontal-tabs" data-md-skip>
   <TabGroup>
     <TabSelect>
       <TabOption target="select-recent">Recent</TabOption>

diff --git a/docs/components/ui/Tabs/VerticalResult.jinja b/docs/components/ui/Tabs/VerticalResult.jinja
@@ -2,9 +2,10 @@
 
 <div class="bg-cover"
   style="background-image:linear-gradient(to right, rgba(56,189,248, 0.3), rgba(37,99,235, 0.3))"
+  data-md-skip
 ></div>
 
-<div class="vertical-tabs">
+<div class="vertical-tabs" data-md-skip>
   <TabGroup>
     <TabList vertical>
       <Tab target="vertical-recent" selected>Recent</Tab>

diff --git a/docs/content/api.md b/docs/content/api.md
@@ -0,0 +1,27 @@
+---
+title: "API reference"
+---
+
+<Header title="API reference" section={{ None }}>
+</Header>
+
+<Autodoc name="jinjax.Catalog" />
+
+----
+
+<Autodoc name="jinjax.LazyString" members={{ False }} />
+
+<Autodoc name="jinjax.HTMLAttrs" />
+
+----
+
+## Exceptions
+
+<Autodoc name="jinjax.ComponentNotFound" level={{ 3 }} members={{ False }} />
+
+<Autodoc name="jinjax.MissingRequiredArgument" level={{ 3 }} members={{ False }} />
+
+<Autodoc name="jinjax.DuplicateDefDeclaration" level={{ 3 }} members={{ False }} />
+
+<Autodoc name="jinjax.InvalidArgument" level={{ 3 }} members={{ False }} />
+