Skip to content
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
15 changes: 14 additions & 1 deletion .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ import llmstxt from "vitepress-plugin-llms";

import type { DefaultTheme } from "vitepress";

import { clientSdkNavbar, pluginsNavbar } from "./navbars";
import {
clientSdkNavbar,
pluginsNavbar,
quickstartNavbar,
} from "./navbars";
import { clientSdkSidebars, pluginsSidebars } from "./sidebars";

// https://vitepress.dev/reference/site-config
Expand Down Expand Up @@ -47,6 +51,15 @@ export default defineConfig({
},

nav: [
{
component: "NavItem",
props: {
text: "Get Started",
link: "/quickstart/",
activeMatch: "^/quickstart(/|$)",
items: quickstartNavbar,
},
},
{
component: "NavItem",
props: {
Expand Down
1 change: 1 addition & 0 deletions .vitepress/navbars/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
export * from "./plugins";
export * from "./client-sdk";
export * from "./quickstart";
5 changes: 5 additions & 0 deletions .vitepress/navbars/quickstart.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import type { DefaultTheme } from "vitepress";

export const quickstartNavbar: DefaultTheme.NavItemWithLink[] = [
{ text: "Get Started", link: "/quickstart/" },
];
4 changes: 3 additions & 1 deletion .vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
--vp-c-brand-2: #95D2B3;
--vp-c-brand-3: #D8EFD3;

--vp-button-brand-active-bg: var(--vp-c-brand-3);
--vp-button-brand-bg: var(--vp-c-brand-1);
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
--vp-button-brand-active-bg: var(--vp-c-brand-1);

}

Expand Down
3 changes: 3 additions & 0 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ hero:

tagline: Developer Documentation
actions:
- theme: brand
Comment thread
ninjeeter marked this conversation as resolved.
text: Get Started
link: /quickstart
- theme: alt
text: Plugins
link: /plugins/guides/
Expand Down
23 changes: 23 additions & 0 deletions src/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Welcome to the Caido Developer Documentation!

Here, you will find a wealth of information and resources for the [Software Development Kits (SDKs)](https://en.wikipedia.org/wiki/Software_development_kit) offered by Caido.

## Plugins

For users looking to customize/extend Caido's functionality, the [@caido/sdk-frontend](/plugins/reference/sdks/frontend/), [@caido/sdk-backend](/plugins/reference/sdks/backend/) kits provide the components and features for creating your own custom plugins.

::: tip
View the [Getting Started](/plugins/guides/) guide to learn how to create your own Caido plugin.
:::

The [@caido/sdk-workflow](/plugins/reference/sdks/workflow/) kit provides the interface for working with Caido data [using the JavaScript node](https://docs.caido.io/app/guides/workflows_javascript.html) in workflows.

For both plugins and workflows, a number of [modules](/plugins/reference/modules/) are supported for Caido’s QuickJS JavaScript engine.

## Client SDK

The [@caido/sdk-client](/client-sdk/reference/) kit provides an interface for programmatic access to a running Caido instance from external scripts and tools.

::: tip
View the [Install the SDK](/client-sdk/guides/install.md) guide to get started.
:::
Loading