@stainless-api/docs 0.1.0-beta.2 → 0.1.0-beta.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/CHANGELOG.md +153 -0
  2. package/components/variables.css +1 -27
  3. package/eslint-suppressions.json +47 -0
  4. package/locals.d.ts +14 -0
  5. package/package.json +30 -27
  6. package/plugin/buildAlgoliaIndex.ts +29 -4
  7. package/plugin/cms/server.ts +97 -54
  8. package/plugin/cms/sidebar-builder.ts +6 -25
  9. package/plugin/cms/worker.ts +2 -2
  10. package/plugin/components/SnippetCode.tsx +7 -4
  11. package/plugin/components/search/SearchAlgolia.astro +0 -7
  12. package/plugin/components/search/SearchIsland.tsx +30 -17
  13. package/plugin/generateAPIReferenceLink.ts +1 -1
  14. package/plugin/globalJs/ai-dropdown-options.ts +161 -0
  15. package/plugin/globalJs/navigation.ts +0 -23
  16. package/plugin/helpers/getPageLoadEvent.ts +1 -1
  17. package/plugin/index.ts +48 -17
  18. package/plugin/languages.ts +1 -1
  19. package/plugin/loadPluginConfig.ts +100 -13
  20. package/plugin/react/Routing.tsx +30 -33
  21. package/plugin/referencePlaceholderUtils.ts +1 -1
  22. package/plugin/replaceSidebarPlaceholderMiddleware.ts +4 -0
  23. package/plugin/routes/Docs.astro +59 -85
  24. package/plugin/routes/Overview.astro +9 -15
  25. package/plugin/routes/markdown.ts +1 -1
  26. package/plugin/vendor/preview.worker.docs.js +6357 -6132
  27. package/resolveSrcFile.ts +10 -0
  28. package/shared/getSharedLogger.ts +15 -0
  29. package/shared/terminalUtils.ts +3 -0
  30. package/src/content.config.ts +9 -0
  31. package/stl-docs/components/AIDropdown.tsx +52 -0
  32. package/stl-docs/components/Head.astro +9 -0
  33. package/stl-docs/components/Header.astro +3 -2
  34. package/stl-docs/components/PageTitle.astro +64 -0
  35. package/stl-docs/components/TableOfContents.astro +34 -0
  36. package/stl-docs/components/ThemeSelect.astro +4 -2
  37. package/stl-docs/components/content-panel/ContentPanel.astro +9 -39
  38. package/stl-docs/components/headers/DefaultHeader.astro +1 -1
  39. package/stl-docs/components/headers/HeaderLinks.astro +1 -1
  40. package/stl-docs/components/headers/StackedHeader.astro +30 -25
  41. package/stl-docs/components/icons/chat-gpt.tsx +17 -0
  42. package/stl-docs/components/icons/claude.tsx +10 -0
  43. package/stl-docs/components/icons/markdown.tsx +10 -0
  44. package/stl-docs/components/index.ts +2 -0
  45. package/stl-docs/components/mintlify-compat/Accordion.astro +7 -38
  46. package/stl-docs/components/mintlify-compat/AccordionGroup.astro +9 -23
  47. package/stl-docs/components/mintlify-compat/Columns.astro +40 -42
  48. package/stl-docs/components/mintlify-compat/Frame.astro +16 -18
  49. package/stl-docs/components/mintlify-compat/Step.astro +30 -32
  50. package/stl-docs/components/mintlify-compat/Steps.astro +8 -10
  51. package/stl-docs/components/mintlify-compat/callouts/Callout.astro +10 -3
  52. package/stl-docs/components/mintlify-compat/callouts/Check.astro +7 -3
  53. package/stl-docs/components/mintlify-compat/callouts/Danger.astro +7 -3
  54. package/stl-docs/components/mintlify-compat/callouts/Info.astro +7 -3
  55. package/stl-docs/components/mintlify-compat/callouts/Note.astro +7 -3
  56. package/stl-docs/components/mintlify-compat/callouts/Tip.astro +7 -3
  57. package/stl-docs/components/mintlify-compat/callouts/Warning.astro +7 -3
  58. package/stl-docs/components/mintlify-compat/card.css +33 -35
  59. package/stl-docs/components/nav-tabs/NavDropdown.astro +1 -1
  60. package/stl-docs/components/nav-tabs/SecondaryNavTabs.astro +15 -7
  61. package/stl-docs/components/nav-tabs/buildNavLinks.ts +4 -3
  62. package/stl-docs/components/pagination/HomeLink.astro +10 -0
  63. package/stl-docs/components/pagination/Pagination.astro +173 -0
  64. package/stl-docs/components/pagination/PaginationLinkEmphasized.astro +22 -0
  65. package/stl-docs/components/pagination/PaginationLinkQuiet.astro +13 -0
  66. package/stl-docs/components/pagination/util.ts +71 -0
  67. package/stl-docs/components/{Sidebar.astro → sidebars/BaseSidebar.astro} +2 -3
  68. package/stl-docs/components/sidebars/SDKSelectSidebar.astro +8 -0
  69. package/stl-docs/disableCalloutSyntax.ts +36 -0
  70. package/stl-docs/index.ts +77 -13
  71. package/stl-docs/loadStlDocsConfig.ts +25 -3
  72. package/stl-docs/proseMarkdown/proseMarkdownIntegration.ts +64 -0
  73. package/stl-docs/proseMarkdown/proseMarkdownMiddleware.ts +34 -0
  74. package/stl-docs/proseMarkdown/toMarkdown.ts +158 -0
  75. package/stl-docs/tabsMiddleware.ts +12 -4
  76. package/styles/code.css +115 -127
  77. package/styles/fonts.css +24 -9
  78. package/styles/links.css +10 -49
  79. package/styles/overrides.css +55 -57
  80. package/styles/page.css +89 -59
  81. package/styles/sdk_select.css +6 -7
  82. package/styles/search.css +65 -67
  83. package/styles/sidebar.css +199 -128
  84. package/styles/toc.css +37 -33
  85. package/theme.css +9 -1
  86. package/tsconfig.json +2 -5
  87. package/virtual-module.d.ts +5 -1
  88. package/plugin/globalJs/ai-dropdown.ts +0 -57
  89. package/stl-docs/components/APIReferenceAIDropdown.tsx +0 -86
  90. package/stl-docs/components/content-panel/ProseAIDropdown.tsx +0 -64
  91. /package/stl-docs/components/{content-panel/ContentBreadcrumbs.tsx → ContentBreadcrumbs.tsx} +0 -0
@@ -1,79 +1,77 @@
1
- @layer stainless {
2
- html {
3
- font-size: 16px;
4
- }
1
+ html {
2
+ font-size: 16px;
3
+ }
5
4
 
6
- .site-title {
7
- color: var(--sl-color-white);
8
- max-width: 144px;
5
+ .site-title {
6
+ color: var(--sl-color-white);
7
+ max-width: 144px;
9
8
 
10
- img {
11
- height: 32px;
12
- width: auto;
13
- }
9
+ img {
10
+ height: 32px;
11
+ width: auto;
14
12
  }
13
+ }
14
+
15
+ /* Hide the text in the theme select dropdown */
16
+ starlight-theme-select select {
17
+ width: 0;
18
+ overflow: hidden;
19
+ }
15
20
 
16
- /* Hide the text in the theme select dropdown */
17
- starlight-theme-select select {
18
- width: 0;
19
- overflow: hidden;
21
+ .custom-select-wrapper select,
22
+ .stldocs-button-secondary {
23
+ background-color: var(--sl-color-bg-ui);
24
+ border: 1px solid var(--sl-color-hairline);
25
+ border-radius: var(--sl-button-border-radius);
26
+
27
+ &:hover {
28
+ border-color: var(--sl-color-hairline-shade);
20
29
  }
30
+ }
31
+
32
+ .content-panel {
33
+ border-top: 0;
34
+ }
21
35
 
22
- .custom-select-wrapper select,
23
- .stldocs-button-secondary {
24
- background-color: var(--sl-color-bg-ui);
25
- border: 1px solid var(--sl-color-hairline);
26
- border-radius: var(--sl-button-border-radius);
36
+ starlight-menu-button button {
37
+ box-shadow: none;
38
+ background-color: var(--sl-color-bg-ui);
39
+ border: 1px solid var(--sl-color-hairline);
40
+ border-radius: var(--sl-button-border-radius);
41
+ height: var(--sl-button-size);
42
+ width: var(--sl-button-size);
43
+ display: flex;
44
+ align-items: center;
45
+ justify-content: center;
27
46
 
28
- &:hover {
29
- border-color: var(--sl-color-hairline-shade);
30
- }
47
+ &:hover {
48
+ border-color: var(--sl-color-hairline-shade);
31
49
  }
50
+ }
32
51
 
33
- .content-panel {
34
- border-top: 0;
52
+ mobile-starlight-toc {
53
+ nav {
54
+ background-color: var(--sl-color-bg);
35
55
  }
36
56
 
37
- starlight-menu-button button {
38
- box-shadow: none;
39
- background-color: var(--sl-color-bg-ui);
40
- border: 1px solid var(--sl-color-hairline);
41
- border-radius: var(--sl-button-border-radius);
42
- height: var(--sl-button-size);
43
- width: var(--sl-button-size);
44
- display: flex;
45
- align-items: center;
46
- justify-content: center;
57
+ summary {
58
+ padding: 2rem 1rem;
59
+ border-bottom-color: var(--sl-color-hairline-light);
60
+ }
61
+ }
47
62
 
48
- &:hover {
49
- border-color: var(--sl-color-hairline-shade);
50
- }
63
+ @media (min-width: 50rem) {
64
+ starlight-menu-button button {
65
+ display: none;
51
66
  }
52
67
 
53
68
  mobile-starlight-toc {
54
69
  nav {
55
- background-color: var(--sl-color-bg);
70
+ inset-inline-start: calc(var(--sl-content-inline-start, 0));
56
71
  }
57
72
 
58
73
  summary {
59
- padding: 2rem 1rem;
60
- border-bottom-color: var(--sl-color-hairline-light);
61
- }
62
- }
63
-
64
- @media (min-width: 50rem) {
65
- starlight-menu-button button {
66
- display: none;
67
- }
68
-
69
- mobile-starlight-toc {
70
- nav {
71
- inset-inline-start: calc(var(--sl-content-inline-start, 0));
72
- }
73
-
74
- summary {
75
- padding: 2rem 2rem;
76
- }
74
+ padding: 2rem 2rem;
77
75
  }
78
76
  }
79
77
  }
package/styles/page.css CHANGED
@@ -1,76 +1,106 @@
1
- /* Styles for supporting a max-width layout */
2
- @layer stainless {
3
- .page {
4
- position: relative;
5
- max-width: var(--sl-page-max-width);
6
- margin: 0 auto;
7
-
8
- .sidebar-pane {
9
- left: auto;
10
- }
1
+ .page,
2
+ .page > header .header,
3
+ .page > header .stl-secondary-nav-tabs {
4
+ max-width: var(--sl-page-max-width);
5
+ margin: 0 auto;
11
6
 
12
- > header {
13
- .stl-secondary-nav-tabs,
14
- .header {
15
- max-width: var(--sl-page-max-width);
16
- margin: 0 auto;
17
- }
18
- }
7
+ @media (min-width: 50rem) {
8
+ padding-inline: var(--stl-ui-page-padding-inline);
9
+ }
10
+ }
19
11
 
20
- .right-sidebar {
21
- border-inline-start: unset;
22
- }
12
+ .page {
13
+ position: relative;
14
+ max-width: var(--sl-page-max-width);
23
15
 
24
- .mobile-preferences {
25
- margin-top: 1rem;
26
- }
16
+ .sidebar-pane {
17
+ left: unset;
27
18
  }
28
19
 
29
- @media (min-width: 50rem) {
30
- .page {
31
- padding-left: var(--sl-sidebar-pad-x);
32
- padding-right: var(--sl-sidebar-pad-x);
33
-
34
- > header {
35
- .header,
36
- .stl-secondary-nav-tabs {
37
- padding: 0 1.5rem;
38
- }
39
- }
40
- }
20
+ .right-sidebar {
21
+ border-inline-start: unset;
22
+ }
41
23
 
42
- .header,
43
- .header {
44
- padding-inline-start: 0;
45
- padding-inline-end: 0;
46
- }
24
+ .mobile-preferences {
25
+ margin-top: 1rem;
26
+ }
27
+ }
47
28
 
48
- mobile-starlight-toc nav {
49
- inset-inline-start: calc(var(--sl-content-inline-start, 0) + var(--sl-sidebar-pad-x));
50
- }
51
- .sidebar-content {
52
- padding-left: 0;
53
- }
29
+ :root {
30
+ --sl-mobile-toc-height: 4rem;
31
+ }
32
+
33
+ @media (min-width: 50rem) {
34
+ /* on desktop, adjust sidebar so that its _text content_ aligns with the page left edge.
35
+ * padding (visible on hover) bleeds out beyond the page left edge, covered by --stl-ui-page-padding-inline */
36
+ .sidebar-pane {
37
+ margin-inline-start: calc(-1 * (var(--sl-sidebar-pad-x) + var(--stl-sidebar-item-padding-inline)));
54
38
  }
55
39
 
56
- .stl-content-breadcrumbs {
57
- .stldocs-breadcrumbs {
58
- padding-left: 0;
59
- }
40
+ .header,
41
+ .header {
42
+ padding-inline-start: 0;
43
+ padding-inline-end: 0;
60
44
  }
61
45
 
62
- .stl-page-nav-container {
63
- display: flex;
64
- align-items: center;
65
- justify-content: space-between;
66
- gap: 1rem;
67
- padding: 1rem 1rem 0;
68
- flex-wrap: wrap;
46
+ mobile-starlight-toc nav {
47
+ inset-inline-start: calc(var(--sl-content-inline-start, 0) + var(--sl-sidebar-pad-x));
69
48
  }
70
49
  }
71
50
 
72
- @media (min-width: 50em) {
51
+ .stl-content-breadcrumbs {
52
+ .stldocs-breadcrumbs {
53
+ padding-left: 0;
54
+ }
55
+ }
56
+
57
+ .stl-page-nav-container {
58
+ display: flex;
59
+ align-items: center;
60
+ justify-content: space-between;
61
+ gap: 1rem;
62
+ padding: 1rem 0 0 0;
63
+ flex-wrap: wrap;
64
+ }
65
+
66
+ .stl-page-nav-container {
67
+ display: flex;
68
+ align-items: center;
69
+ justify-content: space-between;
70
+ gap: 1rem;
71
+ padding: 1rem 0 0 0;
72
+ flex-wrap: wrap;
73
+ }
74
+
75
+ .stldocs-root .stl-page-nav-container {
76
+ padding: 1rem 0 0 var(--stldocs-content-padding);
77
+ }
78
+
79
+ @media (min-width: 50rem) {
73
80
  :root[data-has-sidebar] {
74
- --sl-content-inline-start: calc(var(--sl-sidebar-width) + 1rem);
81
+ --sl-content-inline-start: calc(var(--sl-sidebar-width) + 2rem);
82
+ }
83
+
84
+ .stldocs-root .stl-page-nav-container {
85
+ padding: 1rem 0 0 0;
86
+ }
87
+ }
88
+
89
+ @media (min-width: 72rem) {
90
+ :root {
91
+ --sl-mobile-toc-height: 0rem;
92
+ }
93
+ }
94
+
95
+ .content-panel footer {
96
+ /* Don’t render empty footer meta, which results in extra margin getting applied on behalf of the flex gap.
97
+ * Instead, move its margin to its parent. */
98
+ margin-top: 3rem;
99
+ .meta {
100
+ margin-top: 0;
101
+ &:empty,
102
+ &:not(:has(> *)) {
103
+ display: none;
104
+ }
75
105
  }
76
106
  }
@@ -1,11 +1,10 @@
1
- @layer stainless {
2
- .stl-sdk-select-dropdown-menu {
1
+ .stldocs-root {
2
+ .stldocs-dropdown-menu.stl-sdk-select-dropdown-menu {
3
3
  min-width: 200px;
4
4
  }
5
-
6
- .stl-sdk-select {
7
- .stldocs-icon.http path {
8
- fill: var(--stldocs-color-text);
9
- }
5
+ }
6
+ .stl-sdk-select {
7
+ .stldocs-icon.http path {
8
+ fill: var(--stldocs-color-text);
10
9
  }
11
10
  }
package/styles/search.css CHANGED
@@ -1,84 +1,82 @@
1
- @layer stainless {
2
- /* Search input styles for Astro and Algolia */
3
- site-search {
4
- display: contents;
5
-
6
- > astro-island > div {
7
- position: absolute;
8
- }
9
-
10
- > button {
11
- padding: var(--sl-button-padding-y) var(--sl-button-padding-x);
12
- min-width: unset;
13
- display: flex;
14
- align-items: center;
15
- gap: 0.5rem;
16
- padding: 0;
17
- width: var(--sl-button-size);
18
- justify-content: center;
19
- background-color: var(--sl-color-bg-ui);
20
- border: 1px solid var(--sl-color-hairline);
21
- border-radius: var(--sl-button-border-radius);
22
- height: var(--sl-button-size);
1
+ /* Search input styles for Astro and Algolia */
2
+ site-search {
3
+ display: contents;
23
4
 
24
- &:hover {
25
- border-color: var(--sl-color-hairline-shade);
26
- }
5
+ > astro-island > div {
6
+ position: absolute;
7
+ }
27
8
 
28
- span {
29
- font-size: var(--sl-text-sm);
30
- color: var(--sl-color-text-secondary);
31
- line-height: 150%;
32
- padding-left: var(--sl-button-icon-offset);
33
- padding-right: var(--sl-button-icon-offset);
34
- }
9
+ > button {
10
+ padding: var(--sl-button-padding-y) var(--sl-button-padding-x);
11
+ min-width: unset;
12
+ display: flex;
13
+ align-items: center;
14
+ gap: 0.5rem;
15
+ padding: 0;
16
+ width: var(--sl-button-size);
17
+ justify-content: center;
18
+ background-color: var(--sl-color-bg-ui);
19
+ border: 1px solid var(--sl-color-hairline);
20
+ border-radius: var(--sl-button-border-radius);
21
+ height: var(--sl-button-size);
35
22
 
36
- > svg {
37
- width: var(--sl-text-sm);
38
- height: var(--sl-text-sm);
39
- }
23
+ &:hover {
24
+ border-color: var(--sl-color-hairline-shade);
25
+ }
40
26
 
41
- &.stldocs-button {
42
- padding: 0;
43
- }
27
+ span {
28
+ font-size: var(--sl-text-sm);
29
+ color: var(--sl-color-text-secondary);
30
+ line-height: 150%;
31
+ padding-left: var(--sl-button-icon-offset);
32
+ padding-right: var(--sl-button-icon-offset);
44
33
  }
45
34
 
46
- button > kbd {
47
- border-radius: 0.25rem;
48
- font-size: var(--sl-text-2xs);
49
- gap: 0.25em;
50
- padding-inline: 0.375rem;
51
- background-color: var(--sl-color-gray-6);
52
- margin-right: -0.3rem;
35
+ > svg {
36
+ width: var(--sl-text-sm);
37
+ height: var(--sl-text-sm);
53
38
  }
54
39
 
55
- kbd {
56
- font-family: var(--__sl-font);
57
- color: var(--sl-color-text);
40
+ &.stldocs-button {
41
+ padding: 0;
58
42
  }
59
43
  }
60
44
 
61
- @media (min-width: 50rem) {
62
- site-search {
63
- > button {
64
- border-radius: var(--sl-button-border-radius);
45
+ button > kbd {
46
+ border-radius: 0.25rem;
47
+ font-size: var(--sl-text-2xs);
48
+ gap: 0.25em;
49
+ padding-inline: 0.375rem;
50
+ background-color: var(--sl-color-gray-6);
51
+ margin-right: -0.3rem;
52
+ }
53
+
54
+ kbd {
55
+ font-family: var(--__sl-font);
56
+ color: var(--sl-color-text);
57
+ }
58
+ }
59
+
60
+ @media (min-width: 50rem) {
61
+ site-search {
62
+ > button {
63
+ border-radius: var(--sl-button-border-radius);
64
+ padding-inline-start: var(--sl-button-padding-x);
65
+ padding-inline-end: var(--sl-button-padding-x);
66
+ width: 100%;
67
+ max-width: 30rem;
68
+ justify-content: start;
69
+
70
+ &.stldocs-button {
65
71
  padding-inline-start: var(--sl-button-padding-x);
66
72
  padding-inline-end: var(--sl-button-padding-x);
67
- width: 100%;
68
- max-width: 30rem;
69
- justify-content: start;
70
-
71
- &.stldocs-button {
72
- padding-inline-start: var(--sl-button-padding-x);
73
- padding-inline-end: var(--sl-button-padding-x);
74
- }
73
+ }
75
74
 
76
- > :last-child {
77
- margin-inline-start: auto;
78
- }
79
- > svg {
80
- margin-left: calc(-1 * var(--sl-button-icon-offset));
81
- }
75
+ > :last-child {
76
+ margin-inline-start: auto;
77
+ }
78
+ > svg {
79
+ margin-left: calc(-1 * var(--sl-button-icon-offset));
82
80
  }
83
81
  }
84
82
  }