Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e99d3af
test(tokens): add validation for renamed properties and alias references
GarthDB Feb 12, 2026
d2a1dbb
feat(tools): add markdown-generator for tokens, schemas, and registry
GarthDB Feb 12, 2026
2963b31
feat(docs): scaffold 11ty site based on adobe/11ty-starter
GarthDB Feb 12, 2026
5e6c37c
feat(docs): add custom layouts, collections, and navigation for 11ty …
GarthDB Feb 12, 2026
dde6e37
ci(docs): add workflow to publish markdown to docs-markdown orphan br…
GarthDB Feb 12, 2026
4819de7
ci(docs): update deploy-docs workflow for 11ty site and remove glossa…
GarthDB Feb 12, 2026
5bea930
ci(docs): clean site directory before deploy build
GarthDB Feb 12, 2026
03d9d53
chore(docs): verify build output and clean up
GarthDB Feb 12, 2026
419170d
fix(docs): use YAML frontmatter (---) on 11ty pages, skip remark for …
GarthDB Feb 12, 2026
7474f48
chore: resolved conflicts with main
GarthDB Feb 12, 2026
c2ab5d0
docs(markdown-generator, site): add READMEs and test suite
GarthDB Feb 12, 2026
1abecfd
docs: generate markdown in repo for chatbot indexing
GarthDB Feb 12, 2026
9e0d6ef
fix(site): add CSS build step and fix pathPrefix duplication
GarthDB Feb 12, 2026
02a665c
fix(site): correct markdown source path in copy-content script
GarthDB Feb 12, 2026
761b5b5
fix(site): hard-code navigation to avoid Liquid loop bug
GarthDB Feb 12, 2026
b829e4d
docs(site): add Using with AI page and nav link
GarthDB Feb 13, 2026
016ddc3
docs(site): 11ty config, layouts, CSS structure, and page updates
GarthDB Feb 13, 2026
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
21 changes: 0 additions & 21 deletions .cursor/mcp.json
Original file line number Diff line number Diff line change
@@ -1,30 +1,9 @@
{
"mcpServers": {
"changesets Docs": {
"url": "https://gitmcp.io/changesets/changesets"
},
"ava Docs": {
"url": "https://gitmcp.io/avajs/ava"
},
"moon": {
"command": "moon",
"args": ["mcp"],
"cwd": "${workspaceFolder}"
},
"handlebars.js Docs": {
"url": "https://gitmcp.io/handlebars-lang/handlebars.js"
},
"pnpm Docs": {
"url": "https://gitmcp.io/pnpm/pnpm"
},
"commitlint Docs": {
"url": "https://gitmcp.io/conventional-changelog/commitlint"
},
"GitHub cli Docs": {
"url": "https://gitmcp.io/cli/cli"
},
"nixt Docs": {
"url": "https://gitmcp.io/vesln/nixt"
}
}
}
3 changes: 2 additions & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ jobs:
with:
auto-install: true
- run: moon setup
- run: rm -rf site && mkdir -p site
- run: moon run markdown-generator:generate
- run: moon run site:export
- run: moon run visualizer:build
- run: moon run s2-visualizer:build
Expand All @@ -52,7 +54,6 @@ jobs:
- run: moon run release-timeline:build
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
- run: moon run spectrum-glossary:export
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
Expand Down
7 changes: 6 additions & 1 deletion .lintstagedrc.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
export default {
"**/*.{js,jsx,ts,tsx,json,yml,yaml}": ["prettier --write"],
"**/*.md": (files) => {
// Filter out changeset and CHANGELOG files - they need special handling
// Skip 11ty page templates so YAML frontmatter (---) is not reformatted by remark
// Filter out files that should not be processed by remark:
// - changeset and CHANGELOG files - they need special handling
// - docs/s2-docs files - they have custom YAML frontmatter that remark breaks
// - docs/markdown/ - generated files, regenerated by markdown-generator
const processableFiles = files.filter(
(file) =>
!file.includes(".changeset/") &&
!file.includes("CHANGELOG.md") &&
!file.includes("docs/s2-docs/"),
!file.includes("docs/site/src/") &&
!file.includes("docs/s2-docs/") &&
!file.includes("docs/markdown/"),
);
if (processableFiles.length === 0) return [];
// Use -o flag (no path) to write back to same file
Expand Down
2 changes: 1 addition & 1 deletion .moon/workspace.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ projects:
visualizer: "docs/visualizer"
s2-visualizer: "docs/s2-visualizer"
site: "docs/site"
spectrum-glossary: "docs/spectrum-glossary"
csvGenerator: tools/token-csv-generator
markdown-generator: "tools/markdown-generator"
transform-tokens-json: "tools/transform-tokens-json"
root: "."
diff: "tools/diff-generator"
Expand Down
21 changes: 21 additions & 0 deletions docs/markdown/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Generated Markdown Documentation

This directory contains auto-generated markdown files created from:

- Design tokens (`@adobe/spectrum-tokens`)
- Component schemas (`@adobe/spectrum-component-api-schemas`)
- Design system registry (`@adobe/design-system-registry`)

**DO NOT EDIT THESE FILES MANUALLY**

These files are regenerated by the `markdown-generator` tool and will be overwritten.
To make changes, update the source data in the respective packages.

## Regeneration

Run: `moon run markdown-generator:generate`

These files are used by:

- The 11ty documentation site (`docs/site`)
- Internal Adobe chatbot for design system queries
22 changes: 22 additions & 0 deletions docs/markdown/components/accordion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Accordion
description: "An accordion is a vertically stacked set of interactive headings that each contain a title and a content area."
category: inputs
documentationUrl: https://spectrum.adobe.com/page/accordion/
tags:
- component
- schema
- inputs
---

An accordion is a vertically stacked set of interactive headings that each contain a title and a content area.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| state | string | default, hover, down, keyboard focus | default | No | - |
| size | string | s, m, l, xl | m | No | - |
| isQuiet | boolean | - | false | No | - |
| isDisabled | boolean | - | false | No | - |
| density | string | compact, regular, spacious | regular | No | - |
| items | array | - | - | No | An array of accordion items. |
| isMultiple | boolean | - | false | No | If true, multiple accordion items can be expanded at the same time. |
16 changes: 16 additions & 0 deletions docs/markdown/components/action-bar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Action bar
description: "Action bars are used for single and bulk selection patterns, when a user needs to perform actions on either a single or multiple items at the same time."
category: actions
documentationUrl: https://spectrum.adobe.com/page/action-bar/
tags:
- component
- schema
- actions
---

Action bars are used for single and bulk selection patterns, when a user needs to perform actions on either a single or multiple items at the same time.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| isEmphasized | boolean | - | false | No | - |
27 changes: 27 additions & 0 deletions docs/markdown/components/action-button.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Action button
description: "Action buttons allow users to perform an action or mark a selection. They're used for similar, task-based options within a workflow, and are ideal for interface"
category: actions
documentationUrl: https://spectrum.adobe.com/page/action-button/
tags:
- component
- schema
- actions
---

Action buttons allow users to perform an action or mark a selection. They're used for similar, task-based options within a workflow, and are ideal for interfaces where buttons aren't meant to draw a lot of attention.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| label | string | - | - | No | - |
| hideLabel | boolean | - | false | No | - |
| icon | - | - | - | No | Icon must be present if the label is not defined. |
| size | string | xs, s, m, l, xl | m | No | - |
| isQuiet | boolean | - | false | No | - |
| isSelected | boolean | - | false | No | - |
| isEmphasized | boolean | - | false | No | - |
| staticColor | string | white, black | - | No | Static color must not be set for the default version of this component. |
| selectedTextColor | - | - | - | No | - |
| hasHoldIcon | boolean | - | false | No | - |
| isDisabled | boolean | - | false | No | - |
| state | string | default, hover, down, keyboard focus | default | No | - |
26 changes: 26 additions & 0 deletions docs/markdown/components/action-group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Action group
description: "An action group is a grouping of action buttons that are related to each other."
category: actions
documentationUrl: https://spectrum.adobe.com/page/action-group/
tags:
- component
- schema
- actions
---

An action group is a grouping of action buttons that are related to each other.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| orientation | string | horizontal, vertical | horizontal | No | - |
| size | string | s, m, l, xl | m | No | - |
| density | string | regular, compact | regular | No | - |
| isJustified | boolean | - | false | No | - |
| isQuiet | boolean | - | false | No | - |
| isEmphasized | boolean | - | false | No | - |
| enableSelection | boolean | - | false | No | - |
| selectionMode | string | single, multiple | single | No | Only applicable if selection is enabled |
| allowsEmptySelection | boolean | - | false | No | Only applicable if selection is enabled |
| overflowMode | string | wrap, collapse | wrap | No | - |
| isDisabled | boolean | - | false | No | - |
19 changes: 19 additions & 0 deletions docs/markdown/components/alert-banner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Alert banner
description: "Alert banners show pressing and high-signal messages, such as system alerts. They're meant to be noticed and prompt users to take action."
category: feedback
documentationUrl: https://spectrum.adobe.com/page/alert-banner/
tags:
- component
- schema
- feedback
---

Alert banners show pressing and high-signal messages, such as system alerts. They're meant to be noticed and prompt users to take action.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| text | string | - | - | No | - |
| variant | string | neutral, informative, negative, accent | neutral | No | - |
| actionLabel | string | - | - | No | If undefined, this button does not appear. |
| isDismissible | boolean | - | false | No | - |
21 changes: 21 additions & 0 deletions docs/markdown/components/alert-dialog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Alert dialog
description: "Alert dialogs display important information that users need to acknowledge. They appear over the interface and block further interactions until an action is sel"
category: feedback
documentationUrl: https://spectrum.adobe.com/page/alert-dialog/
tags:
- component
- schema
- feedback
---

Alert dialogs display important information that users need to acknowledge. They appear over the interface and block further interactions until an action is selected.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| title | string | - | - | No | - |
| description | string | - | - | No | - |
| variant | string | confirmation, information, warning, destructive, error | confirmation | No | - |
| primaryActionLabel | string | - | - | No | - |
| secondaryActionLabel | string | - | - | No | If undefined, this button does not appear. |
| cancelActionLabel | string | - | cancel | No | If undefined, this button does not appear. |
17 changes: 17 additions & 0 deletions docs/markdown/components/avatar-group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Avatar group
description: "Avatar groups display a collection of avatars representing people or entities."
category: actions
documentationUrl: https://spectrum.adobe.com/page/avatar-group/
tags:
- component
- schema
- actions
---

Avatar groups display a collection of avatars representing people or entities.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| label | string | - | - | No | Optional text label displayed with the avatar group (e.g., group name). |
| size | number | 50, 75, 100, 200, 300, 400, 500 | 100 | No | - |
20 changes: 20 additions & 0 deletions docs/markdown/components/avatar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Avatar
description: "An avatar is a thumbnail representation of an entity, such as a user or an organization."
category: navigation
documentationUrl: https://spectrum.adobe.com/page/avatar/
tags:
- component
- schema
- navigation
---

An avatar is a thumbnail representation of an entity, such as a user or an organization.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| size | number | 50, 75, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500 | 500 | No | - |
| image | string | user image, gradient image, gradient, guest image, initials | user image | No | - |
| isDisabled | boolean | - | false | No | - |
| showStroke | boolean | - | false | No | - |
| state | string | default, down, keyboard focus | default | No | - |
22 changes: 22 additions & 0 deletions docs/markdown/components/badge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Badge
description: "Similar to status lights, badges are for showing a small amount of color-categorized metadata. They're ideal for getting a user''s attention."
category: status
documentationUrl: https://spectrum.adobe.com/page/badge/
tags:
- component
- schema
- status
---

Similar to status lights, badges are for showing a small amount of color-categorized metadata. They're ideal for getting a user''s attention.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| label | string | - | - | No | When the label is not defined, the badge appears as icon-only. |
| icon | - | - | - | No | - |
| variant | string | neutral, info, positive, negative, indigo, yellow, magenta, fuchsia, purple, seafoam, accent, notice, gray, red, orange, chartreuse, celery, green, cyan, blue, pink, turquoise, brown, cinnamon, silver | - | No | - |
| style | string | bold, subtle, outline | - | No | - |
| fixed | string | none, top, right, bottom, left | none | No | - |
| isDisabled | boolean | - | false | No | - |
| size | string | s, m, l, xl | s | No | - |
18 changes: 18 additions & 0 deletions docs/markdown/components/body.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Body
description: "Body is a typography component primarily used within Spectrum components and for blocks of text."
category: typography
documentationUrl: https://spectrum.adobe.com/page/body/
tags:
- component
- schema
- typography
---

Body is a typography component primarily used within Spectrum components and for blocks of text.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| script | - | - | - | No | - |
| classification | - | - | - | No | - |
| size | string | xs, s, m, l, xl, xxl, xxxl | m | No | - |
21 changes: 21 additions & 0 deletions docs/markdown/components/bottom-navigation-android.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Bottom navigation (Android)
description: "Bottom navigation is a top-level navigation control for Android apps."
category: navigation
documentationUrl: https://spectrum.adobe.com/page/bottom-navigation-android/
tags:
- component
- schema
- navigation
---

Bottom navigation is a top-level navigation control for Android apps.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| label | string | - | - | No | - |
| labelPosition | string | bottom, side | bottom | No | - |
| icon | - | - | - | No | - |
| background | string | primary, secondary | primary | No | - |
| hasBadge | boolean | - | false | No | - |
| isDisabled | boolean | - | false | No | - |
22 changes: 22 additions & 0 deletions docs/markdown/components/breadcrumbs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Breadcrumbs
description: "Breadcrumbs show hierarchy and navigational context for a user’s location within an app."
category: navigation
documentationUrl: https://spectrum.adobe.com/page/breadcrumbs/
tags:
- component
- schema
- navigation
---

Breadcrumbs show hierarchy and navigational context for a user’s location within an app.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| state | string | default, hover, down, keyboard focus, drag and drop | default | No | - |
| isMultiline | boolean | - | false | No | If true, the breadcrumb items will wrap to multiple lines. |
| size | string | m, l | m | No | Controls the overall size of the breadcrumb component. |
| items | array | - | - | No | An array of breadcrumb items. |
| separator | string | chevron, none | chevron | No | The separator icon used between breadcrumb items. |
| isTruncated | boolean | - | false | No | If true, the breadcrumb item is truncated and displayed as icon only. |
| sizeOverride | string | s, m, l, xl | - | No | Overrides the size of the breadcrumb items when isMultiline is true. |
19 changes: 19 additions & 0 deletions docs/markdown/components/button-group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Button group
description: "A button group is a grouping of buttons whose actions are related to each other."
category: actions
documentationUrl: https://spectrum.adobe.com/page/button-group/
tags:
- component
- schema
- actions
---

A button group is a grouping of buttons whose actions are related to each other.

| Property | Type | Values | Default | Required | Description |
| --- | --- | --- | --- | --- | --- |
| orientation | string | horizontal, vertical | horizontal | No | - |
| size | string | s, m, l, xl | m | No | - |
| overflowMode | string | wrap, collapse | wrap | No | - |
| isDisabled | boolean | - | false | No | - |
Loading