Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs #82

Merged
merged 12 commits into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/components/Copyright.jinja
Original file line number Diff line number Diff line change
@@ -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>
12 changes: 6 additions & 6 deletions docs/components/Home.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
4 changes: 1 addition & 3 deletions docs/components/NavExtra.jinja
Original file line number Diff line number Diff line change
@@ -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" />
3 changes: 2 additions & 1 deletion docs/components/ui/Accordion/DemoResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
4 changes: 0 additions & 4 deletions docs/components/ui/Dialog/DemoPreview.jinja
Original file line number Diff line number Diff line change
@@ -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>
3 changes: 2 additions & 1 deletion docs/components/ui/LinkedList/DemoResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
3 changes: 2 additions & 1 deletion docs/components/ui/Menu/DemoResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 2 additions & 1 deletion docs/components/ui/Popover/DemoResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
3 changes: 2 additions & 1 deletion docs/components/ui/Tabs/DemoResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 2 additions & 1 deletion docs/components/ui/Tabs/ManualResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 2 additions & 1 deletion docs/components/ui/Tabs/SelectResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 2 additions & 1 deletion docs/components/ui/Tabs/VerticalResult.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
27 changes: 27 additions & 0 deletions docs/content/api.md
Original file line number Diff line number Diff line change
@@ -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 }} />

Loading
Loading