Skip to content

DeepTeam is a framework to red team LLMs and AI agents.

updated docs

penguineaed41b6fe2c6
diff --git a/docs/docs/getting-started.mdx b/docs/docs/getting-started.mdx
index f98e63ea..83b2b8d3 100644
--- a/docs/docs/getting-started.mdx
+++ b/docs/docs/getting-started.mdx
@@ -17,7 +17,7 @@ import TabItem from "@theme/TabItem";
- Simulate adversarial attacks using 10+ methods including jailbreaking, prompt injection, automated evasion, data extraction, and response manipulation.
- Customize security assessments to align with OWASP Top 10 for LLMs, NIST AI Risk Management, and industry best practices.
-Additionally, **DeepTeam is powered by [DeepEval](https://docs.confident-ai.com)**, the open-source LLM evaluation framework. Whilst DeepEval focuses on regular LLM evaluation, DeepTeam is dedicated for red teaming.
+Additionally, **DeepTeam is built on [DeepEval](https://docs.confident-ai.com)**, the open-source LLM evaluation framework. Whilst DeepEval focuses on regular LLM evaluation, DeepTeam is dedicated for red teaming.
<Envelope />
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index 5c718ccd..7aca2d79 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -175,7 +175,7 @@ const config: Config = {
id: "announcementBar-1",
content:
'⭐️ If you like DeepTeam, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/confident-ai/deepteam">GitHub</a>! ⭐️',
- backgroundColor: "#ff006b",
+ backgroundColor: "#de0064",
textColor: "#000",
},
footer: {
diff --git a/docs/src/css/custom.scss b/docs/src/css/custom.scss
index 8fa7333a..2fe70d71 100644
--- a/docs/src/css/custom.scss
+++ b/docs/src/css/custom.scss
@@ -8,13 +8,13 @@
}
:root {
- --ifm-color-primary: #ff0062;
- --ifm-color-primary-dark: #f6174f;
- --ifm-color-primary-darker: #f50a45;
- --ifm-color-primary-darkest: #c90839;
- --ifm-color-primary-light: #f8517b;
- --ifm-color-primary-lighter: #f95f86;
- --ifm-color-primary-lightest: #fa8aa6;
+ --ifm-color-primary: #de0064;
+ --ifm-color-primary-dark: #c8005a;
+ --ifm-color-primary-darker: #bd0055;
+ --ifm-color-primary-darkest: #9b0046;
+ --ifm-color-primary-light: #f4006e;
+ --ifm-color-primary-lighter: #ff0073;
+ --ifm-color-primary-lightest: #ff2285;
--ifm-code-font-size: 85%;
--ifm-menu-color: #747680 !important;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
@@ -85,13 +85,13 @@
/* For readability concerns, you should choose a lighter palette in dark mode. */
html[data-theme="dark"] {
- --ifm-color-primary: #f3154c;
- --ifm-color-primary-dark: #f6174f;
- --ifm-color-primary-darker: #f50a45;
- --ifm-color-primary-darkest: #ff1c55;
- --ifm-color-primary-light: #e40545;
- --ifm-color-primary-lighter: #ff265c;
- --ifm-color-primary-lightest: #fa8aa6;
+ --ifm-color-primary: #ff0073;
+ --ifm-color-primary-dark: #e60067;
+ --ifm-color-primary-darker: #d90062;
+ --ifm-color-primary-darkest: #b30050;
+ --ifm-color-primary-light: #ff1a81;
+ --ifm-color-primary-lighter: #ff2688;
+ --ifm-color-primary-lightest: #ff4d9d;
--ifm-background-color: #090b0e;
--ifm-background-surface-color: #13171e;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
@@ -241,12 +241,12 @@ html[data-theme="light"] .navbar__logo {
// Announcement bar
div[role="banner"][class*="announcementBar"] {
font-weight: 600;
- background-color: #ff0062 !important;
+ background-color: #de0064 !important;
color: white !important;
}
html[data-theme="light"] div[role="banner"][class*="announcementBar"] {
- background-color: #ff0062 !important;
+ background-color: #de0064 !important;
color: white !important;
}
@@ -282,26 +282,6 @@ html[data-theme="dark"] .header-github-link:before {
no-repeat;
}
-.footer {
- background: #0e1015;
-}
-
-.footer__copyright {
- font-size: 13px;
-}
-
-.footer__link-item {
- color: #9ca3af;
-}
-
-.footer__link-item:hover {
- text-decoration: none;
-}
-
-.footer__bottom {
- margin: 40px auto 10px auto;
-}
-
.header-discord-link:hover {
opacity: 0.6;
}
@@ -646,3 +626,11 @@ html[data-theme="dark"] .header-confident-link:hover {
display: none;
}
}
+
+.pagination-nav__link {
+ border-radius: 0px;
+
+ .pagination-nav__label {
+ font-weight: 600;
+ }
+}
diff --git a/docs/src/theme/Footer/index.tsx b/docs/src/theme/Footer/index.tsx
new file mode 100644
index 00000000..a6ef2a44
--- /dev/null
+++ b/docs/src/theme/Footer/index.tsx
@@ -0,0 +1,124 @@
+import React from "react";
+import Link from "@docusaurus/Link";
+import styles from "./styles.module.scss";
+
+const LINKS = {
+ product: [
+ { label: "Getting Started", to: "/docs/getting-started" },
+ { label: "Vulnerabilities", to: "/docs/red-teaming-vulnerabilities" },
+ {
+ label: "Adversarial Attacks",
+ to: "/docs/red-teaming-adversarial-attacks",
+ },
+ { label: "Guardrails", to: "/docs/guardrails-introduction" },
+ { label: "Frameworks", to: "/docs/frameworks-introduction" },
+ ],
+ reads: [
+ {
+ label: "Red Teaming AI Agents",
+ to: "/guides/guide-agentic-ai-red-teaming",
+ },
+ { label: "Red Teaming RAG", to: "/guides/guide-red-teaming-agentic-rag" },
+ { label: "Safety Frameworks", to: "/guides/guide-safety-frameworks" },
+ { label: "Building Custom Attacks", to: "/guides/guide-custom-attacks" },
+ { label: "Deploying Guardrails", to: "/guides/guide-deploying-guardrails" },
+ ],
+ ecosystem: [
+ { label: "Confident AI", href: "https://www.confident-ai.com" },
+ { label: "DeepEval", href: "https://deepeval.com" },
+ ],
+};
+
+function GitHubIcon() {
+ return (
+ <svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor">
+ <path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12" />
+ </svg>
+ );
+}
+
+function Footer() {
+ return (
+ <footer className={styles.footer}>
+ <div className={styles.inner}>
+ <div className={styles.top}>
+ <div className={styles.brand}>
+ <img
+ src="/icons/DeepTeam.svg"
+ alt="DeepTeam"
+ className={styles.logo}
+ />
+ <p className={styles.tagline}>
+ Open-source LLM red teaming framework. Apache 2.0 licensed.
+ </p>
+ <Link
+ href="https://github.com/confident-ai/deepteam"
+ className={styles.starButton}
+ >
+ <GitHubIcon /> Star us on GitHub
+ </Link>
+ </div>
+
+ <div className={styles.columns}>
+ <div className={styles.column}>
+ <h4 className={styles.columnTitle}>Product</h4>
+ <ul className={styles.columnList}>
+ {LINKS.product.map((link) => (
+ <li key={link.label}>
+ <Link to={link.to} className={styles.link}>
+ {link.label}
+ </Link>
+ </li>
+ ))}
+ </ul>
+ </div>
+
+ <div className={styles.column}>
+ <h4 className={styles.columnTitle}>Very Useful Reads</h4>
+ <ul className={styles.columnList}>
+ {LINKS.reads.map((link) => (
+ <li key={link.label}>
+ <Link to={link.to} className={styles.link}>
+ {link.label}
+ </Link>
+ </li>
+ ))}
+ </ul>
+ </div>
+
+ <div className={styles.column}>
+ <h4 className={styles.columnTitle}>Ecosystem</h4>
+ <ul className={styles.columnList}>
+ {LINKS.ecosystem.map((link) => (
+ <li key={link.label}>
+ <Link href={link.href} className={styles.link}>
+ {link.label}
+ </Link>
+ </li>
+ ))}
+ </ul>
+ </div>
+ </div>
+ </div>
+
+ <div className={styles.divider} />
+
+ <div className={styles.bottom}>
+ <span className={styles.copyright}>
+ &copy; {new Date().getFullYear()} Confident AI Inc. Made with 🖤 and
+ confidence.
+ </span>
+ </div>
+ </div>
+
+ {/* <img
+ src="/icons/DeepTeam.svg"
+ alt=""
+ className={styles.wordmark}
+ aria-hidden="true"
+ /> */}
+ </footer>
+ );
+}
+
+export default React.memo(Footer);
diff --git a/docs/src/theme/Footer/styles.module.scss b/docs/src/theme/Footer/styles.module.scss
new file mode 100644
index 00000000..fec22351
--- /dev/null
+++ b/docs/src/theme/Footer/styles.module.scss
@@ -0,0 +1,130 @@
+.footer {
+ background: #de0064;
+ overflow: hidden;
+ padding: 0;
+
+ .inner {
+ max-width: 1200px;
+ margin: 0 auto;
+ padding: 48px 24px 24px;
+ }
+
+ .top {
+ display: flex;
+ gap: 64px;
+
+ @media (max-width: 768px) {
+ flex-direction: column;
+ gap: 40px;
+ }
+ }
+
+ .brand {
+ flex-shrink: 0;
+ width: 350px;
+ margin-right: 48px;
+
+ @media (max-width: 768px) {
+ max-width: 100%;
+ }
+
+ .logo {
+ height: 22px;
+ width: auto;
+ }
+
+ .tagline {
+ margin: 12px 0 16px;
+ font-size: 13px;
+ line-height: 1.5;
+ color: rgba(255, 255, 255, 0.85);
+ }
+
+ .starButton {
+ display: inline-flex;
+ align-items: center;
+ gap: 8px;
+ font-size: 13px;
+ font-weight: 500;
+ color: #fff;
+ background: rgba(0, 0, 0, 0.15);
+ padding: 6px 14px;
+ transition: background 0.15s;
+
+ &:hover {
+ background: rgba(0, 0, 0, 0.3);
+ color: #fff;
+ text-decoration: none;
+ }
+ }
+ }
+
+ .columns {
+ display: flex;
+ flex: 1;
+ gap: 40px;
+
+ @media (max-width: 768px) {
+ flex-wrap: wrap;
+ gap: 32px;
+ }
+
+ .column {
+ flex: 1;
+ min-width: 140px;
+
+ .columnTitle {
+ font-size: 13px;
+ font-weight: 600;
+ color: rgba(255, 255, 255);
+ margin: 0 0 12px;
+ }
+
+ .columnList {
+ list-style: none;
+ margin: 0;
+ padding: 0;
+ display: flex;
+ flex-direction: column;
+ gap: 6px;
+
+ .link {
+ font-size: 13px;
+ color: rgba(255, 255, 255, 0.85);
+ transition: color 0.15s;
+ }
+ }
+ }
+ }
+
+ .divider {
+ height: 1px;
+ background: rgba(255, 255, 255, 0.25);
+ margin: 32px 0 16px;
+ }
+
+ .bottom {
+ display: flex;
+ align-items: center;
+ justify-content: space-between;
+
+ @media (max-width: 768px) {
+ flex-direction: column;
+ gap: 8px;
+ }
+
+ .copyright {
+ font-size: 12px;
+ color: rgba(255, 255, 255);
+ }
+ }
+
+ .wordmark {
+ display: block;
+ width: 100%;
+ height: auto;
+ margin-top: 48px;
+ opacity: 1;
+ margin-bottom: -6.5%;
+ }
+}