From 46e031a087a17f15438343c5f2f0a7c6ebd8d831 Mon Sep 17 00:00:00 2001 From: Emiliano Bonilla <56323762+emilbon99@users.noreply.github.com> Date: Sat, 14 Sep 2024 17:06:11 -0700 Subject: [PATCH] [docs/site] - added breadcrumbs and next and prev buttons to docs site --- docs/site/src/components/NextPrev.astro | 72 ++++++++++++++++ .../site/src/components/article/Article.astro | 38 ++++++++- .../src/components/article/Breadcrumb.astro | 7 ++ docs/site/src/layouts/MainLayout.astro | 12 ++- docs/site/src/pages/index.mdx | 1 + .../pages/reference/cluster/cli-reference.mdx | 4 + .../src/pages/reference/cluster/index.astro | 3 + .../pages/reference/cluster/installation.mdx | 4 + .../pages/reference/cluster/production.mdx | 4 + .../pages/reference/cluster/quick-start.mdx | 5 +- .../pages/reference/cluster/requirements.mdx | 4 + .../reference/cluster/systemd-service.mdx | 2 + .../src/pages/reference/concepts/channels.mdx | 4 + .../reference/concepts/clusters-and-nodes.mdx | 4 + .../src/pages/reference/concepts/index.astro | 3 + .../src/pages/reference/concepts/overview.mdx | 2 + .../src/pages/reference/concepts/ranges.mdx | 4 + .../src/pages/reference/concepts/reads.mdx | 4 + .../src/pages/reference/concepts/streams.mdx | 2 + .../src/pages/reference/concepts/writes.mdx | 4 + .../src/pages/reference/console/channels.mdx | 4 + .../src/pages/reference/console/clusters.mdx | 4 + .../pages/reference/console/get-started.mdx | 2 + .../src/pages/reference/console/index.astro | 3 + .../pages/reference/console/line-plots.mdx | 4 + .../src/pages/reference/console/ranges.mdx | 4 + .../pages/reference/console/schematics.mdx | 2 + .../pages/reference/console/ui-overview.mdx | 4 + .../pages/reference/console/workspaces.mdx | 4 + .../src/pages/reference/control/examples.mdx | 2 + .../pages/reference/control/get-started.mdx | 4 +- .../src/pages/reference/control/index.astro | 3 + .../reference/control/sequence-basics.mdx | 4 + .../reference/device-drivers/get-started.mdx | 2 + .../reference/device-drivers/index.astro | 3 + .../device-drivers/ni/analog-read-task.mdx | 4 + .../device-drivers/ni/configure-device.mdx | 4 + .../device-drivers/ni/digital-read-task.mdx | 2 + .../device-drivers/ni/digital-write-task.mdx | 4 + .../device-drivers/ni/get-started.mdx | 2 + .../reference/device-drivers/ni/index.astro | 3 + .../device-drivers/opc-ua/connect-server.mdx | 2 + .../device-drivers/opc-ua/index.astro | 3 + .../device-drivers/opc-ua/read-task.mdx | 4 + .../device-drivers/opc-ua/write-task.mdx | 2 + .../src/pages/reference/pluto/example-app.mdx | 2 + .../src/pages/reference/pluto/get-started.mdx | 2 + .../src/pages/reference/pluto/index.astro | 3 + .../src/pages/reference/pluto/line-plot.mdx | 4 + .../reference/pluto/provider-and-canvas.mdx | 4 + .../src/pages/reference/pluto/theming.mdx | 4 + .../reference/python-client/channels.mdx | 4 + .../reference/python-client/delete-data.mdx | 4 + .../reference/python-client/examples.mdx | 4 + .../reference/python-client/get-started.mdx | 4 +- .../pages/reference/python-client/index.astro | 3 + .../pages/reference/python-client/ranges.mdx | 4 + .../reference/python-client/read-data.mdx | 4 + .../python-client/series-and-frames.mdx | 4 + .../reference/python-client/stream-data.mdx | 4 + .../python-client/troubleshooting.mdx | 2 + .../reference/python-client/write-data.mdx | 4 + .../reference/typescript-client/channels.mdx | 4 + .../typescript-client/delete-data.mdx | 4 + .../reference/typescript-client/examples.mdx | 4 + .../typescript-client/get-started.mdx | 2 + .../reference/typescript-client/index.astro | 3 + .../reference/typescript-client/read-data.mdx | 4 + .../typescript-client/series-and-frames.mdx | 4 + .../typescript-client/stream-data.mdx | 4 + .../typescript-client/timestamps.mdx | 4 + .../typescript-client/troubleshooting.mdx | 2 + .../typescript-client/write-data.mdx | 4 + pluto/src/breadcrumb/Breadcrumb.tsx | 82 +++++++++++++++---- x/ts/src/caseconv/caseconv.ts | 5 +- 75 files changed, 423 insertions(+), 25 deletions(-) create mode 100644 docs/site/src/components/NextPrev.astro create mode 100644 docs/site/src/components/article/Breadcrumb.astro create mode 100644 docs/site/src/pages/reference/cluster/index.astro create mode 100644 docs/site/src/pages/reference/concepts/index.astro create mode 100644 docs/site/src/pages/reference/console/index.astro create mode 100644 docs/site/src/pages/reference/control/index.astro create mode 100644 docs/site/src/pages/reference/device-drivers/index.astro create mode 100644 docs/site/src/pages/reference/device-drivers/ni/index.astro create mode 100644 docs/site/src/pages/reference/device-drivers/opc-ua/index.astro create mode 100644 docs/site/src/pages/reference/pluto/index.astro create mode 100644 docs/site/src/pages/reference/python-client/index.astro create mode 100644 docs/site/src/pages/reference/typescript-client/index.astro diff --git a/docs/site/src/components/NextPrev.astro b/docs/site/src/components/NextPrev.astro new file mode 100644 index 0000000000..7baf310d67 --- /dev/null +++ b/docs/site/src/components/NextPrev.astro @@ -0,0 +1,72 @@ +--- +import { Icon } from "@synnaxlabs/media"; +import { Align, Button, Divider, Text } from "@synnaxlabs/pluto"; +const { next, prev, nextURL, prevURL } = Astro.props; +--- + + + {(next != null || prev != null) && } + + + { + prev != null && ( + <> + + + + Previous + + {prev} + + + ) + } + + + { + next != null && ( + <> + + + Next + + {next} + + + + ) + } + + + + + diff --git a/docs/site/src/components/article/Article.astro b/docs/site/src/components/article/Article.astro index 185f73e0be..128ad577ef 100644 --- a/docs/site/src/components/article/Article.astro +++ b/docs/site/src/components/article/Article.astro @@ -1,11 +1,15 @@ --- -const { title, description } = Astro.props; +import Breadcrumb from "@/components/article/Breadcrumb.astro"; +import NextPrev from "@/components/NextPrev.astro"; +const { title, description, url, next, prev, nextURL, prevURL } = Astro.props; ---
+

{title}

{description}

+