@lukoweb/apitogo 0.2.22 → 0.2.24

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 (599) hide show
  1. package/README.md +94 -94
  2. package/cli.js +13 -13
  3. package/client.d.ts +8 -8
  4. package/dist/cli/cli.js +561 -232
  5. package/dist/declarations/cli/platform/client/platform-api.d.ts +18 -0
  6. package/dist/declarations/config/validators/InputNavigationSchema.d.ts +7 -7
  7. package/dist/declarations/config/validators/ZudokuConfig.d.ts +1 -1
  8. package/docs/cli/commands.md +75 -75
  9. package/docs/cli/go-live.md +123 -123
  10. package/docs/cli/overview.md +91 -91
  11. package/docs/cli/setup.md +141 -141
  12. package/docs/cli/shape.md +127 -127
  13. package/docs/components/alert.mdx +130 -130
  14. package/docs/components/badge.mdx +70 -70
  15. package/docs/components/button.mdx +132 -132
  16. package/docs/components/callout.mdx +112 -112
  17. package/docs/components/card.mdx +104 -104
  18. package/docs/components/checkbox.mdx +72 -72
  19. package/docs/components/client-only.mdx +79 -79
  20. package/docs/components/code-tabs.mdx +179 -179
  21. package/docs/components/dialog.mdx +167 -167
  22. package/docs/components/head.mdx +200 -200
  23. package/docs/components/icons.mdx +27 -27
  24. package/docs/components/input.mdx +96 -96
  25. package/docs/components/label.mdx +86 -86
  26. package/docs/components/link.mdx +242 -242
  27. package/docs/components/markdown.mdx +151 -151
  28. package/docs/components/mermaid.mdx +81 -81
  29. package/docs/components/playground.mdx +85 -85
  30. package/docs/components/secret.mdx +79 -79
  31. package/docs/components/select.mdx +176 -176
  32. package/docs/components/shadcn.mdx +73 -73
  33. package/docs/components/slider.mdx +108 -108
  34. package/docs/components/slot.mdx +119 -119
  35. package/docs/components/stepper.mdx +138 -138
  36. package/docs/components/switch.mdx +96 -96
  37. package/docs/components/syntax-highlight.mdx +602 -602
  38. package/docs/components/textarea.mdx +78 -78
  39. package/docs/components/tooltip.mdx +195 -195
  40. package/docs/components/typography.mdx +61 -61
  41. package/docs/components.mdx +60 -60
  42. package/docs/concepts/auth-provider-api-identities.md +105 -105
  43. package/docs/configuration/ai-assistants.md +65 -65
  44. package/docs/configuration/api-catalog.md +109 -109
  45. package/docs/configuration/api-reference.md +397 -397
  46. package/docs/configuration/authentication-auth0.md +181 -181
  47. package/docs/configuration/authentication-azure-ad.md +245 -245
  48. package/docs/configuration/authentication-clerk.md +117 -117
  49. package/docs/configuration/authentication-firebase.md +69 -69
  50. package/docs/configuration/authentication-pingfederate.md +143 -143
  51. package/docs/configuration/authentication-supabase.md +233 -233
  52. package/docs/configuration/authentication.md +159 -159
  53. package/docs/configuration/build-configuration.mdx +147 -147
  54. package/docs/configuration/docs.md +282 -282
  55. package/docs/configuration/footer.mdx +118 -118
  56. package/docs/configuration/gateway.md +221 -221
  57. package/docs/configuration/llms.md +90 -90
  58. package/docs/configuration/make-config.mdx +124 -124
  59. package/docs/configuration/manifest.md +128 -128
  60. package/docs/configuration/navigation.mdx +421 -421
  61. package/docs/configuration/overview.md +166 -166
  62. package/docs/configuration/plans.md +153 -153
  63. package/docs/configuration/protected-routes.md +150 -150
  64. package/docs/configuration/search.md +164 -164
  65. package/docs/configuration/sentry.mdx +44 -44
  66. package/docs/configuration/site.md +124 -124
  67. package/docs/configuration/slots.mdx +125 -125
  68. package/docs/configuration/vite-config.md +18 -18
  69. package/docs/custom-plugins.md +285 -285
  70. package/docs/customization/colors-theme.mdx +278 -278
  71. package/docs/customization/fonts.md +110 -110
  72. package/docs/customization/landing-page.md +188 -188
  73. package/docs/deploy/apache-nginx.md +41 -41
  74. package/docs/deploy/apitogo.md +17 -17
  75. package/docs/deploy/cloudflare-pages.md +74 -74
  76. package/docs/deploy/direct-upload.md +17 -17
  77. package/docs/deploy/github-pages.md +49 -49
  78. package/docs/deploy/vercel.md +101 -101
  79. package/docs/deployment.md +9 -9
  80. package/docs/extending/events.md +124 -124
  81. package/docs/guides/custom-pages.md +110 -110
  82. package/docs/guides/environment-variables.md +94 -94
  83. package/docs/guides/managing-api-keys-and-identities.md +89 -89
  84. package/docs/guides/mermaid.mdx +70 -70
  85. package/docs/guides/navigation-rules.mdx +203 -203
  86. package/docs/guides/processors.mdx +234 -234
  87. package/docs/guides/static-files.md +55 -55
  88. package/docs/guides/transforming-examples.md +156 -156
  89. package/docs/guides/using-multiple-apis.md +87 -87
  90. package/docs/markdown/admonitions.md +128 -128
  91. package/docs/markdown/code-blocks.md +196 -196
  92. package/docs/markdown/frontmatter.md +173 -173
  93. package/docs/markdown/mdx.md +68 -68
  94. package/docs/markdown/overview.md +275 -275
  95. package/docs/mcp/go-live.md +100 -100
  96. package/docs/mcp/overview.md +76 -76
  97. package/docs/mcp/setup.md +173 -173
  98. package/docs/mcp/shape.md +77 -77
  99. package/docs/mcp/tools.md +102 -102
  100. package/docs/plugins.md +24 -24
  101. package/docs/quickstart.md +72 -72
  102. package/docs/writing.mdx +72 -72
  103. package/package.json +1 -1
  104. package/src/app/ZuploBuildConfig.ts +36 -36
  105. package/src/app/apitogoBrandTheme.ts +47 -47
  106. package/src/app/defaultTheme.css +77 -77
  107. package/src/app/demo-cdn.html +37 -37
  108. package/src/app/demo.html +21 -21
  109. package/src/app/demo.tsx +77 -77
  110. package/src/app/entry.client.tsx +107 -107
  111. package/src/app/entry.server.tsx +160 -160
  112. package/src/app/env.ts +40 -40
  113. package/src/app/main.css +400 -400
  114. package/src/app/main.tsx +167 -167
  115. package/src/app/polyfills.ts +47 -47
  116. package/src/app/processRoutes.tsx +51 -51
  117. package/src/app/sentry.ts +24 -24
  118. package/src/app/standalone.html +23 -23
  119. package/src/app/standalone.tsx +60 -60
  120. package/src/app/utils/createRedirectRoutes.ts +11 -11
  121. package/src/config/apitogo-config-core.ts +7 -3
  122. package/src/config/apitogo-config-loader.browser.ts +17 -17
  123. package/src/config/apitogo-config-loader.node.ts +88 -88
  124. package/src/config/apitogo-config-loader.ts +6 -6
  125. package/src/config/build-apitogo-config.ts +61 -61
  126. package/src/config/config.ts +74 -74
  127. package/src/config/create-plugin.ts +71 -71
  128. package/src/config/default-landing-content.ts +149 -149
  129. package/src/config/file-exists.ts +6 -6
  130. package/src/config/gateway-limits.ts +128 -128
  131. package/src/config/landing-manifest.ts +11 -11
  132. package/src/config/landing-openapi-showcase.ts +124 -124
  133. package/src/config/loader.ts +375 -375
  134. package/src/config/local-manifest.ts +545 -545
  135. package/src/config/resolve-modules.ts +354 -354
  136. package/src/config/v2/__fixtures__/scenario-a-docs-only.json +6 -6
  137. package/src/config/v2/__fixtures__/scenario-b-managed-origin.json +14 -14
  138. package/src/config/v2/__fixtures__/scenario-c-proxy-oidc.json +15 -15
  139. package/src/config/v2/__fixtures__/scenario-h-full-stack.json +28 -28
  140. package/src/config/v2/docs-navigation.ts +72 -72
  141. package/src/config/v2/errors.ts +42 -42
  142. package/src/config/v2/gateway-reference.ts +220 -220
  143. package/src/config/v2/gateway-request.ts +123 -123
  144. package/src/config/v2/home-redirect.ts +98 -98
  145. package/src/config/v2/index.ts +126 -126
  146. package/src/config/v2/init.ts +273 -273
  147. package/src/config/v2/layout.ts +237 -237
  148. package/src/config/v2/ledger.ts +235 -235
  149. package/src/config/v2/link-directory.ts +34 -0
  150. package/src/config/v2/load.ts +70 -70
  151. package/src/config/v2/manifest.ts +452 -452
  152. package/src/config/v2/parse.ts +214 -214
  153. package/src/config/v2/paths.ts +54 -54
  154. package/src/config/v2/portal-profile.ts +88 -88
  155. package/src/config/v2/resolve.ts +188 -188
  156. package/src/config/v2/rules.ts +714 -714
  157. package/src/config/v2/schema.ts +245 -245
  158. package/src/config/v2/services.ts +663 -663
  159. package/src/config/v2/workspace.ts +3 -2
  160. package/src/config/v2/wrapper.ts +24 -2
  161. package/src/config/validators/BuildSchema.ts +95 -95
  162. package/src/config/validators/HeaderNavigationSchema.ts +44 -44
  163. package/src/config/validators/InputNavigationSchema.test-d.ts +178 -178
  164. package/src/config/validators/InputNavigationSchema.ts +206 -206
  165. package/src/config/validators/ModulesSchema.ts +502 -502
  166. package/src/config/validators/NavigationSchema.ts +352 -352
  167. package/src/config/validators/ProtectedRoutesSchema.ts +35 -35
  168. package/src/config/validators/ZudokuConfig.ts +792 -792
  169. package/src/config/validators/auth.ts +3 -3
  170. package/src/config/validators/reason-codes.ts +7 -7
  171. package/src/env.d.ts +11 -11
  172. package/src/index.ts +83 -83
  173. package/src/lib/MissingIcon.tsx +22 -22
  174. package/src/lib/assets/language-icons/bun.tsx +50 -50
  175. package/src/lib/assets/language-icons/c.tsx +31 -31
  176. package/src/lib/assets/language-icons/commonlisp.tsx +22 -22
  177. package/src/lib/assets/language-icons/cpp.tsx +35 -35
  178. package/src/lib/assets/language-icons/csharp.tsx +35 -35
  179. package/src/lib/assets/language-icons/css.tsx +36 -36
  180. package/src/lib/assets/language-icons/dart.tsx +39 -39
  181. package/src/lib/assets/language-icons/elixir.tsx +19 -19
  182. package/src/lib/assets/language-icons/go.tsx +19 -19
  183. package/src/lib/assets/language-icons/graphql.tsx +19 -19
  184. package/src/lib/assets/language-icons/html.tsx +24 -24
  185. package/src/lib/assets/language-icons/java.tsx +35 -35
  186. package/src/lib/assets/language-icons/javascript.tsx +11 -11
  187. package/src/lib/assets/language-icons/json.tsx +19 -19
  188. package/src/lib/assets/language-icons/kotlin.tsx +30 -30
  189. package/src/lib/assets/language-icons/markdown.tsx +19 -19
  190. package/src/lib/assets/language-icons/mdx.tsx +23 -23
  191. package/src/lib/assets/language-icons/npm.tsx +15 -15
  192. package/src/lib/assets/language-icons/objectivec.tsx +23 -23
  193. package/src/lib/assets/language-icons/ocaml.tsx +34 -34
  194. package/src/lib/assets/language-icons/php.tsx +19 -19
  195. package/src/lib/assets/language-icons/pnpm.tsx +32 -32
  196. package/src/lib/assets/language-icons/powershell.tsx +27 -27
  197. package/src/lib/assets/language-icons/python.tsx +23 -23
  198. package/src/lib/assets/language-icons/react.tsx +21 -21
  199. package/src/lib/assets/language-icons/ruby.tsx +19 -19
  200. package/src/lib/assets/language-icons/rust.tsx +19 -19
  201. package/src/lib/assets/language-icons/scala.tsx +19 -19
  202. package/src/lib/assets/language-icons/shell.tsx +19 -19
  203. package/src/lib/assets/language-icons/swift.tsx +19 -19
  204. package/src/lib/assets/language-icons/toml.tsx +23 -23
  205. package/src/lib/assets/language-icons/typescript.tsx +23 -23
  206. package/src/lib/assets/language-icons/xml.tsx +19 -19
  207. package/src/lib/assets/language-icons/yaml.tsx +23 -23
  208. package/src/lib/assets/language-icons/yarn.tsx +17 -17
  209. package/src/lib/assets/language-icons/zig.tsx +32 -32
  210. package/src/lib/auth/issuer.ts +34 -34
  211. package/src/lib/authentication/AuthenticationPlugin.tsx +33 -33
  212. package/src/lib/authentication/auth-header-nav.ts +46 -46
  213. package/src/lib/authentication/authentication.ts +51 -51
  214. package/src/lib/authentication/components/CallbackHandler.tsx +45 -45
  215. package/src/lib/authentication/components/OAuthErrorPage.tsx +197 -197
  216. package/src/lib/authentication/components/ProductionUnlockPage.tsx +26 -26
  217. package/src/lib/authentication/components/SignIn.tsx +46 -46
  218. package/src/lib/authentication/components/SignOut.tsx +15 -15
  219. package/src/lib/authentication/components/SignUp.tsx +48 -48
  220. package/src/lib/authentication/constants.ts +1 -1
  221. package/src/lib/authentication/errors.ts +34 -34
  222. package/src/lib/authentication/header-nav-filter.ts +35 -35
  223. package/src/lib/authentication/hook.ts +141 -141
  224. package/src/lib/authentication/providers/auth0.tsx +91 -91
  225. package/src/lib/authentication/providers/azureb2c.tsx +223 -223
  226. package/src/lib/authentication/providers/clerk.tsx +224 -224
  227. package/src/lib/authentication/providers/dev-portal-auth-pages.tsx +602 -602
  228. package/src/lib/authentication/providers/dev-portal-constants.ts +38 -38
  229. package/src/lib/authentication/providers/dev-portal-demo.ts +151 -151
  230. package/src/lib/authentication/providers/dev-portal-utils.ts +279 -279
  231. package/src/lib/authentication/providers/dev-portal.tsx +448 -448
  232. package/src/lib/authentication/providers/firebase.tsx +486 -486
  233. package/src/lib/authentication/providers/openid.tsx +516 -516
  234. package/src/lib/authentication/providers/supabase.tsx +412 -412
  235. package/src/lib/authentication/providers/util.ts +26 -26
  236. package/src/lib/authentication/state.ts +180 -180
  237. package/src/lib/authentication/ui/AuthCard.tsx +7 -7
  238. package/src/lib/authentication/ui/EmailLinkCallbackUi.tsx +129 -129
  239. package/src/lib/authentication/ui/EmailLinkSentUi.tsx +105 -105
  240. package/src/lib/authentication/ui/EmailLinkSignInUi.tsx +100 -100
  241. package/src/lib/authentication/ui/EmailVerificationUi.tsx +128 -128
  242. package/src/lib/authentication/ui/ZudokuAuthUi.tsx +620 -620
  243. package/src/lib/authentication/ui/icons/Apple.tsx +10 -10
  244. package/src/lib/authentication/ui/icons/Facebook.tsx +15 -15
  245. package/src/lib/authentication/ui/icons/Github.tsx +16 -16
  246. package/src/lib/authentication/ui/icons/Google.tsx +16 -16
  247. package/src/lib/authentication/ui/icons/Microsoft.tsx +12 -12
  248. package/src/lib/authentication/ui/icons/X.tsx +10 -10
  249. package/src/lib/authentication/utils/relativeRedirectUrl.ts +16 -16
  250. package/src/lib/components/AiAssistantMenuItems.tsx +102 -102
  251. package/src/lib/components/AnchorLink.tsx +24 -24
  252. package/src/lib/components/Autocomplete.tsx +123 -123
  253. package/src/lib/components/Banner.tsx +52 -52
  254. package/src/lib/components/Bootstrap.tsx +77 -77
  255. package/src/lib/components/BuildCheck.tsx +87 -87
  256. package/src/lib/components/CategoryHeading.tsx +19 -19
  257. package/src/lib/components/ClientOnly.tsx +19 -19
  258. package/src/lib/components/DeveloperHint.tsx +39 -39
  259. package/src/lib/components/ErrorPage.tsx +26 -26
  260. package/src/lib/components/Footer.tsx +146 -146
  261. package/src/lib/components/Framed.tsx +51 -51
  262. package/src/lib/components/Header.tsx +261 -261
  263. package/src/lib/components/HeaderAuthActions.tsx +32 -32
  264. package/src/lib/components/HeaderNavigation.tsx +176 -176
  265. package/src/lib/components/Heading.tsx +84 -84
  266. package/src/lib/components/InlineCode.tsx +15 -15
  267. package/src/lib/components/LandingLayout.tsx +27 -27
  268. package/src/lib/components/LanguageIcon.tsx +199 -199
  269. package/src/lib/components/Layout.tsx +59 -59
  270. package/src/lib/components/Main.tsx +52 -52
  271. package/src/lib/components/Markdown.tsx +55 -55
  272. package/src/lib/components/Mermaid.tsx +74 -74
  273. package/src/lib/components/Meta.tsx +46 -46
  274. package/src/lib/components/MobileTopNavigation.tsx +283 -283
  275. package/src/lib/components/MultiSelect.tsx +86 -86
  276. package/src/lib/components/NotFoundPage.tsx +37 -37
  277. package/src/lib/components/PageProgress.tsx +28 -28
  278. package/src/lib/components/PagefindSearchMeta.tsx +14 -14
  279. package/src/lib/components/Pagination.tsx +44 -44
  280. package/src/lib/components/PathRenderer.tsx +61 -61
  281. package/src/lib/components/PluginHeads.tsx +17 -17
  282. package/src/lib/components/Search.tsx +70 -70
  283. package/src/lib/components/SiteTitle.tsx +58 -58
  284. package/src/lib/components/Slot.tsx +65 -65
  285. package/src/lib/components/Spinner.tsx +5 -5
  286. package/src/lib/components/StatusPage.tsx +96 -96
  287. package/src/lib/components/ThemeSwitch.tsx +99 -99
  288. package/src/lib/components/TopNavigation.tsx +90 -90
  289. package/src/lib/components/Typography.tsx +12 -12
  290. package/src/lib/components/Zudoku.tsx +105 -105
  291. package/src/lib/components/cache.ts +27 -27
  292. package/src/lib/components/context/RenderContext.ts +11 -11
  293. package/src/lib/components/context/RouterEventsEmitter.tsx +19 -19
  294. package/src/lib/components/context/SlotProvider.tsx +149 -149
  295. package/src/lib/components/context/ViewportAnchorContext.tsx +137 -137
  296. package/src/lib/components/context/ZudokuContext.ts +140 -140
  297. package/src/lib/components/context/ZudokuProvider.tsx +20 -20
  298. package/src/lib/components/context/ZudokuReactContext.tsx +17 -17
  299. package/src/lib/components/index.ts +36 -36
  300. package/src/lib/components/navigation/Navigation.tsx +51 -51
  301. package/src/lib/components/navigation/NavigationBadge.tsx +48 -48
  302. package/src/lib/components/navigation/NavigationCategory.tsx +157 -157
  303. package/src/lib/components/navigation/NavigationFilterContext.tsx +28 -28
  304. package/src/lib/components/navigation/NavigationFilterInput.tsx +35 -35
  305. package/src/lib/components/navigation/NavigationItem.tsx +181 -181
  306. package/src/lib/components/navigation/NavigationWrapper.tsx +49 -49
  307. package/src/lib/components/navigation/PoweredByZudoku.tsx +39 -39
  308. package/src/lib/components/navigation/Toc.tsx +137 -137
  309. package/src/lib/components/navigation/ZudokuLogo.tsx +25 -25
  310. package/src/lib/components/navigation/ZuploLogo.tsx +14 -14
  311. package/src/lib/components/navigation/utils.ts +234 -234
  312. package/src/lib/core/RouteGuard.tsx +260 -260
  313. package/src/lib/core/ZudokuContext.ts +272 -272
  314. package/src/lib/core/plugins.ts +139 -139
  315. package/src/lib/core/react-query.ts +1 -1
  316. package/src/lib/core/router.ts +1 -1
  317. package/src/lib/core/transform-config.ts +67 -67
  318. package/src/lib/demo/DemoAnnouncement.tsx +17 -17
  319. package/src/lib/errors/ErrorAlert.tsx +28 -28
  320. package/src/lib/errors/ErrorMessage.tsx +50 -50
  321. package/src/lib/errors/RouterError.tsx +18 -18
  322. package/src/lib/errors/ServerError.tsx +5 -5
  323. package/src/lib/errors/TopLevelError.tsx +6 -6
  324. package/src/lib/hooks/index.ts +13 -13
  325. package/src/lib/hooks/useEvent.ts +41 -41
  326. package/src/lib/hooks/useHighlighter.ts +15 -15
  327. package/src/lib/hooks/useHotkey.ts +70 -70
  328. package/src/lib/icons.ts +2 -2
  329. package/src/lib/navigation/applyRules.ts +127 -127
  330. package/src/lib/navigation/pathMatcher.ts +81 -81
  331. package/src/lib/oas/graphql/circular.ts +69 -69
  332. package/src/lib/oas/graphql/constants.ts +2 -2
  333. package/src/lib/oas/graphql/index.ts +791 -791
  334. package/src/lib/oas/parser/dereference/index.ts +84 -84
  335. package/src/lib/oas/parser/dereference/resolveRef.ts +32 -32
  336. package/src/lib/oas/parser/index.ts +129 -129
  337. package/src/lib/oas/parser/schemas/v3.0.json +1489 -1489
  338. package/src/lib/oas/parser/schemas/v3.1.json +1298 -1298
  339. package/src/lib/oas/parser/upgrade/index.ts +174 -174
  340. package/src/lib/plugins/api-catalog/Catalog.tsx +80 -80
  341. package/src/lib/plugins/api-catalog/index.tsx +119 -119
  342. package/src/lib/plugins/api-keys/CreateApiKey.tsx +128 -128
  343. package/src/lib/plugins/api-keys/CreateApiKeyDialog.tsx +49 -49
  344. package/src/lib/plugins/api-keys/ProtectedRoute.tsx +33 -33
  345. package/src/lib/plugins/api-keys/SettingsApiKeys.tsx +72 -72
  346. package/src/lib/plugins/api-keys/index.tsx +274 -274
  347. package/src/lib/plugins/api-keys/settings/ApiKeyItem.tsx +342 -342
  348. package/src/lib/plugins/api-keys/settings/ApiKeyList.tsx +67 -67
  349. package/src/lib/plugins/api-keys/settings/RevealApiKey.tsx +127 -127
  350. package/src/lib/plugins/custom-pages/index.tsx +32 -32
  351. package/src/lib/plugins/markdown/MdxPage.tsx +260 -260
  352. package/src/lib/plugins/markdown/assets/ChatGPTLogo.tsx +11 -11
  353. package/src/lib/plugins/markdown/assets/ClaudeLogo.tsx +19 -19
  354. package/src/lib/plugins/markdown/index.tsx +82 -82
  355. package/src/lib/plugins/openapi/ApiHeader.tsx +96 -96
  356. package/src/lib/plugins/openapi/CollapsibleCode.tsx +88 -88
  357. package/src/lib/plugins/openapi/ColorizedParam.tsx +115 -115
  358. package/src/lib/plugins/openapi/DownloadSchemaButton.tsx +94 -94
  359. package/src/lib/plugins/openapi/Endpoint.tsx +85 -85
  360. package/src/lib/plugins/openapi/GeneratedExampleSidecarBox.tsx +52 -52
  361. package/src/lib/plugins/openapi/MCPEndpoint.tsx +273 -273
  362. package/src/lib/plugins/openapi/OasProvider.tsx +74 -74
  363. package/src/lib/plugins/openapi/OperationList.tsx +275 -275
  364. package/src/lib/plugins/openapi/OperationListItem.tsx +183 -183
  365. package/src/lib/plugins/openapi/ParamInfos.tsx +96 -96
  366. package/src/lib/plugins/openapi/ParameterList.tsx +53 -53
  367. package/src/lib/plugins/openapi/ParameterListItem.tsx +161 -161
  368. package/src/lib/plugins/openapi/PlaygroundDialogWrapper.tsx +67 -67
  369. package/src/lib/plugins/openapi/RequestBodySidecarBox.tsx +63 -63
  370. package/src/lib/plugins/openapi/ResponsesSidecarBox.tsx +120 -120
  371. package/src/lib/plugins/openapi/SchemaInfo.tsx +344 -344
  372. package/src/lib/plugins/openapi/SchemaList.tsx +113 -113
  373. package/src/lib/plugins/openapi/Sidecar.tsx +314 -314
  374. package/src/lib/plugins/openapi/SidecarBox.tsx +57 -57
  375. package/src/lib/plugins/openapi/SidecarExamples.tsx +177 -177
  376. package/src/lib/plugins/openapi/SimpleSelect.tsx +46 -46
  377. package/src/lib/plugins/openapi/client/GraphQLClient.tsx +73 -73
  378. package/src/lib/plugins/openapi/client/GraphQLContext.tsx +16 -16
  379. package/src/lib/plugins/openapi/client/createServer.ts +35 -35
  380. package/src/lib/plugins/openapi/client/useCreateQuery.ts +44 -44
  381. package/src/lib/plugins/openapi/components/ConstValue.tsx +24 -24
  382. package/src/lib/plugins/openapi/components/EnumValues.tsx +58 -58
  383. package/src/lib/plugins/openapi/components/NonHighlightedCode.tsx +22 -22
  384. package/src/lib/plugins/openapi/components/ResponseContent.tsx +117 -117
  385. package/src/lib/plugins/openapi/components/SelectOnClick.tsx +29 -29
  386. package/src/lib/plugins/openapi/context.tsx +16 -16
  387. package/src/lib/plugins/openapi/graphql/fragment-masking.ts +104 -104
  388. package/src/lib/plugins/openapi/graphql/gql.ts +95 -95
  389. package/src/lib/plugins/openapi/graphql/graphql.ts +835 -835
  390. package/src/lib/plugins/openapi/graphql/index.ts +2 -2
  391. package/src/lib/plugins/openapi/index.tsx +221 -221
  392. package/src/lib/plugins/openapi/interfaces.ts +100 -100
  393. package/src/lib/plugins/openapi/playground/BodyPanel.tsx +274 -274
  394. package/src/lib/plugins/openapi/playground/CollapsibleHeader.tsx +51 -51
  395. package/src/lib/plugins/openapi/playground/ExamplesDropdown.tsx +60 -60
  396. package/src/lib/plugins/openapi/playground/Headers.tsx +194 -194
  397. package/src/lib/plugins/openapi/playground/IdentityDialog.tsx +75 -75
  398. package/src/lib/plugins/openapi/playground/IdentitySelector.tsx +38 -38
  399. package/src/lib/plugins/openapi/playground/ParamsGrid.tsx +45 -45
  400. package/src/lib/plugins/openapi/playground/PathParams.tsx +53 -53
  401. package/src/lib/plugins/openapi/playground/Playground.tsx +602 -602
  402. package/src/lib/plugins/openapi/playground/PlaygroundDialog.tsx +62 -62
  403. package/src/lib/plugins/openapi/playground/QueryParams.tsx +151 -151
  404. package/src/lib/plugins/openapi/playground/RequestLoginDialog.tsx +70 -70
  405. package/src/lib/plugins/openapi/playground/Spinner.tsx +87 -87
  406. package/src/lib/plugins/openapi/playground/createUrl.ts +25 -25
  407. package/src/lib/plugins/openapi/playground/fileUtils.ts +36 -36
  408. package/src/lib/plugins/openapi/playground/rememberedIdentity.ts +26 -26
  409. package/src/lib/plugins/openapi/playground/request-panel/MultipartField.tsx +91 -91
  410. package/src/lib/plugins/openapi/playground/request-panel/UrlPath.tsx +31 -31
  411. package/src/lib/plugins/openapi/playground/request-panel/UrlQueryParams.tsx +29 -29
  412. package/src/lib/plugins/openapi/playground/request-panel/useKeyValueFieldManager.ts +340 -340
  413. package/src/lib/plugins/openapi/playground/result-panel/AudioPlayer.tsx +50 -50
  414. package/src/lib/plugins/openapi/playground/result-panel/ResponseStatusBar.tsx +117 -117
  415. package/src/lib/plugins/openapi/playground/result-panel/ResponseTab.tsx +355 -355
  416. package/src/lib/plugins/openapi/playground/result-panel/ResultPanel.tsx +106 -106
  417. package/src/lib/plugins/openapi/playground/result-panel/convertToTypes.ts +36 -36
  418. package/src/lib/plugins/openapi/playground/serializeQueryParams.ts +125 -125
  419. package/src/lib/plugins/openapi/playground/useRememberSkipLoginDialog.tsx +23 -23
  420. package/src/lib/plugins/openapi/processors/injectApitogoGatewayServer.ts +36 -36
  421. package/src/lib/plugins/openapi/processors/removeExtensions.ts +29 -29
  422. package/src/lib/plugins/openapi/processors/removeParameters.ts +103 -103
  423. package/src/lib/plugins/openapi/processors/removePaths.ts +57 -57
  424. package/src/lib/plugins/openapi/processors/traverse.ts +1 -1
  425. package/src/lib/plugins/openapi/schema/SchemaExampleAndDefault.tsx +39 -39
  426. package/src/lib/plugins/openapi/schema/SchemaPropertyItem.tsx +189 -189
  427. package/src/lib/plugins/openapi/schema/SchemaView.tsx +299 -299
  428. package/src/lib/plugins/openapi/schema/UnionView.tsx +132 -132
  429. package/src/lib/plugins/openapi/schema/union-helpers.ts +123 -123
  430. package/src/lib/plugins/openapi/schema/utils.ts +49 -49
  431. package/src/lib/plugins/openapi/state.ts +36 -36
  432. package/src/lib/plugins/openapi/util/buildTagCategories.ts +54 -54
  433. package/src/lib/plugins/openapi/util/createHttpSnippet.ts +135 -135
  434. package/src/lib/plugins/openapi/util/createNavigationCategory.tsx +39 -39
  435. package/src/lib/plugins/openapi/util/generateSchemaExample.ts +191 -191
  436. package/src/lib/plugins/openapi/util/getRoutes.tsx +265 -265
  437. package/src/lib/plugins/openapi/util/methodColorMap.tsx +11 -11
  438. package/src/lib/plugins/openapi/util/methodToColor.ts +27 -27
  439. package/src/lib/plugins/openapi/util/sanitizeMarkdownForMetatag.tsx +32 -32
  440. package/src/lib/plugins/openapi/util/useWarmupSchema.ts +23 -23
  441. package/src/lib/plugins/search-inkeep/index.tsx +108 -108
  442. package/src/lib/plugins/search-inkeep/inkeep.ts +24 -24
  443. package/src/lib/plugins/search-pagefind/IndexingDialog.tsx +162 -162
  444. package/src/lib/plugins/search-pagefind/PagefindSearch.tsx +202 -202
  445. package/src/lib/plugins/search-pagefind/ResultList.tsx +122 -122
  446. package/src/lib/plugins/search-pagefind/get-results.tsx +74 -74
  447. package/src/lib/plugins/search-pagefind/index.tsx +21 -21
  448. package/src/lib/plugins/search-pagefind/types.ts +118 -118
  449. package/src/lib/shiki-constants.ts +24 -24
  450. package/src/lib/shiki.ts +179 -179
  451. package/src/lib/testing/index.tsx +147 -147
  452. package/src/lib/ui/Accordion.tsx +55 -55
  453. package/src/lib/ui/ActionButton.tsx +21 -21
  454. package/src/lib/ui/Alert.tsx +84 -84
  455. package/src/lib/ui/AlertDialog.tsx +195 -195
  456. package/src/lib/ui/AspectRatio.tsx +5 -5
  457. package/src/lib/ui/Badge.tsx +48 -48
  458. package/src/lib/ui/Breadcrumb.tsx +115 -115
  459. package/src/lib/ui/Button.tsx +65 -65
  460. package/src/lib/ui/ButtonGroup.tsx +80 -80
  461. package/src/lib/ui/Callout.tsx +113 -113
  462. package/src/lib/ui/Card.tsx +95 -95
  463. package/src/lib/ui/Carousel.tsx +259 -259
  464. package/src/lib/ui/Checkbox.tsx +28 -28
  465. package/src/lib/ui/CodeBlock.tsx +92 -92
  466. package/src/lib/ui/CodeTabPanel.tsx +13 -13
  467. package/src/lib/ui/CodeTabs.tsx +161 -161
  468. package/src/lib/ui/Collapsible.tsx +31 -31
  469. package/src/lib/ui/Command.tsx +191 -191
  470. package/src/lib/ui/Dialog.tsx +138 -138
  471. package/src/lib/ui/DismissibleAlert.tsx +74 -74
  472. package/src/lib/ui/Drawer.tsx +121 -121
  473. package/src/lib/ui/DropdownMenu.tsx +254 -254
  474. package/src/lib/ui/EmbeddedCodeBlock.tsx +99 -99
  475. package/src/lib/ui/Form.tsx +176 -176
  476. package/src/lib/ui/Frame.tsx +81 -81
  477. package/src/lib/ui/HoverCard.tsx +26 -26
  478. package/src/lib/ui/Input.tsx +23 -23
  479. package/src/lib/ui/InputGroup.tsx +168 -168
  480. package/src/lib/ui/Item.tsx +213 -213
  481. package/src/lib/ui/Kbd.tsx +28 -28
  482. package/src/lib/ui/Label.tsx +23 -23
  483. package/src/lib/ui/NativeSelect.tsx +48 -48
  484. package/src/lib/ui/NavigationMenu.tsx +169 -169
  485. package/src/lib/ui/Pagination.tsx +115 -115
  486. package/src/lib/ui/Popover.tsx +28 -28
  487. package/src/lib/ui/Progress.tsx +25 -25
  488. package/src/lib/ui/RadioGroup.tsx +41 -41
  489. package/src/lib/ui/ReactComponentDoc.tsx +68 -68
  490. package/src/lib/ui/ScrollArea.tsx +45 -45
  491. package/src/lib/ui/Secret.tsx +133 -133
  492. package/src/lib/ui/Select.tsx +184 -184
  493. package/src/lib/ui/Separator.tsx +25 -25
  494. package/src/lib/ui/Skeleton.tsx +15 -15
  495. package/src/lib/ui/Slider.tsx +25 -25
  496. package/src/lib/ui/Stepper.tsx +8 -8
  497. package/src/lib/ui/Switch.tsx +26 -26
  498. package/src/lib/ui/SyntaxHighlight.tsx +54 -54
  499. package/src/lib/ui/Tabs.tsx +52 -52
  500. package/src/lib/ui/Textarea.tsx +22 -22
  501. package/src/lib/ui/Toggle.tsx +42 -42
  502. package/src/lib/ui/ToggleGroup.tsx +58 -58
  503. package/src/lib/ui/Tooltip.tsx +65 -65
  504. package/src/lib/ui/Value.tsx +42 -42
  505. package/src/lib/ui/util.tsx +8 -8
  506. package/src/lib/util/MdxComponents.tsx +150 -150
  507. package/src/lib/util/cn.ts +6 -6
  508. package/src/lib/util/createVariantComponent.tsx +61 -61
  509. package/src/lib/util/ensureArray.ts +3 -3
  510. package/src/lib/util/flattenAllOf.ts +72 -72
  511. package/src/lib/util/flattenAllOfProcessor.ts +74 -74
  512. package/src/lib/util/hastToJsx.tsx +67 -67
  513. package/src/lib/util/humanFileSize.ts +15 -15
  514. package/src/lib/util/invariant.ts +52 -52
  515. package/src/lib/util/joinUrl.ts +60 -60
  516. package/src/lib/util/logInit.ts +9 -9
  517. package/src/lib/util/objectEntries.ts +5 -5
  518. package/src/lib/util/os.ts +18 -18
  519. package/src/lib/util/pastellize.ts +25 -25
  520. package/src/lib/util/problemJson.ts +63 -63
  521. package/src/lib/util/readFrontmatter.ts +14 -14
  522. package/src/lib/util/renderIf.ts +4 -4
  523. package/src/lib/util/scrollIntoViewIfNeeded.ts +18 -18
  524. package/src/lib/util/slugify.ts +21 -21
  525. package/src/lib/util/syncZustandState.ts +22 -22
  526. package/src/lib/util/traverse.ts +70 -70
  527. package/src/lib/util/types.ts +7 -7
  528. package/src/lib/util/url.ts +18 -18
  529. package/src/lib/util/useCopyToClipboard.ts +17 -17
  530. package/src/lib/util/useExposedProps.tsx +27 -27
  531. package/src/lib/util/useIsomorphicLayoutEffect.ts +6 -6
  532. package/src/lib/util/useLatest.ts +18 -18
  533. package/src/lib/util/useOnScreen.ts +34 -34
  534. package/src/lib/util/useScrollToAnchor.ts +75 -75
  535. package/src/lib/util/useScrollToTop.ts +18 -18
  536. package/src/types.d.ts +66 -66
  537. package/src/vite/api/SchemaManager.ts +371 -371
  538. package/src/vite/api/schema-codegen.ts +163 -163
  539. package/src/vite/build.ts +237 -237
  540. package/src/vite/config.ts +273 -273
  541. package/src/vite/css/collect.ts +42 -42
  542. package/src/vite/css/plugin.ts +105 -105
  543. package/src/vite/debug.ts +18 -18
  544. package/src/vite/dev-portal-env.ts +29 -29
  545. package/src/vite/dev-server.ts +294 -294
  546. package/src/vite/html.ts +52 -52
  547. package/src/vite/index.ts +2 -2
  548. package/src/vite/llms.ts +99 -99
  549. package/src/vite/mdx/rehype-extract-toc-with-jsx-export.ts +19 -19
  550. package/src/vite/mdx/rehype-extract-toc-with-jsx.ts +70 -70
  551. package/src/vite/mdx/remark-code-tabs.ts +47 -47
  552. package/src/vite/mdx/remark-inject-filepath.ts +13 -13
  553. package/src/vite/mdx/remark-last-modified.ts +103 -103
  554. package/src/vite/mdx/remark-link-rewrite.ts +23 -23
  555. package/src/vite/mdx/remark-normalize-image-url.ts +15 -15
  556. package/src/vite/mdx/remark-static-generation.ts +149 -149
  557. package/src/vite/mdx/utils.ts +32 -32
  558. package/src/vite/output.ts +261 -261
  559. package/src/vite/package-root.ts +12 -12
  560. package/src/vite/pagefind-dev-index.ts +100 -100
  561. package/src/vite/pagefind-dev-stub.ts +17 -17
  562. package/src/vite/plugin-api-keys.ts +55 -55
  563. package/src/vite/plugin-api.ts +328 -328
  564. package/src/vite/plugin-auth.ts +41 -41
  565. package/src/vite/plugin-component.ts +45 -45
  566. package/src/vite/plugin-config-reload.ts +47 -47
  567. package/src/vite/plugin-config.ts +131 -131
  568. package/src/vite/plugin-custom-pages.ts +36 -36
  569. package/src/vite/plugin-doc-metadata.ts +45 -45
  570. package/src/vite/plugin-docs.ts +205 -205
  571. package/src/vite/plugin-local-manifest.ts +100 -100
  572. package/src/vite/plugin-markdown-export.ts +214 -214
  573. package/src/vite/plugin-mdx.ts +149 -149
  574. package/src/vite/plugin-metadata.ts +30 -30
  575. package/src/vite/plugin-modules.ts +188 -188
  576. package/src/vite/plugin-navigation.ts +106 -106
  577. package/src/vite/plugin-offroot-resolve.ts +67 -67
  578. package/src/vite/plugin-search.ts +59 -59
  579. package/src/vite/plugin-shiki-register.ts +97 -97
  580. package/src/vite/plugin-theme.ts +458 -458
  581. package/src/vite/plugin.ts +48 -48
  582. package/src/vite/prerender/prerender.ts +242 -242
  583. package/src/vite/prerender/utils.ts +76 -76
  584. package/src/vite/prerender/worker.ts +118 -118
  585. package/src/vite/reporter.ts +34 -34
  586. package/src/vite/shadcn-registry.ts +48 -48
  587. package/src/vite/sitemap.ts +78 -78
  588. package/src/vite/ssr-templates/cloudflare.ts +19 -19
  589. package/src/vite/ssr-templates/node.ts +25 -25
  590. package/src/vite/ssr-templates/vercel.ts +22 -22
  591. package/src/vite/watch-ignore.ts +70 -70
  592. package/src/vite/zuplo.ts +30 -30
  593. package/src/vite-env.d.ts +6 -6
  594. package/src/zuplo/enrich-with-zuplo-mcp.ts +168 -168
  595. package/src/zuplo/enrich-with-zuplo.ts +256 -256
  596. package/src/zuplo/policy-types.ts +46 -46
  597. package/src/zuplo/with-zuplo-processors.ts +36 -36
  598. package/src/zuplo/with-zuplo.ts +14 -14
  599. package/dist/declarations/cli/platform/client/deploy-server.d.ts +0 -16
@@ -1,602 +1,602 @@
1
- ---
2
- title: Syntax Highlight
3
- sidebar_icon: code
4
- ---
5
-
6
- import { SyntaxHighlight } from "@lukoweb/apitogo/ui/SyntaxHighlight";
7
- import { Callout } from "@lukoweb/apitogo/ui/Callout";
8
-
9
- Add syntax highlighting to your code blocks with customizable styling and features. The component
10
- offers extensive customization options including line numbers, copy buttons, language indicators,
11
- and custom theming to match your brand. For simpler use cases, you can also use standard Markdown
12
- code blocks as described in [Code Blocks](/docs/markdown/code-blocks).
13
-
14
- :::tip
15
-
16
- You can also use backticks to highlight code blocks in Markdown files, see
17
- [Code Blocks](../markdown/code-blocks) for more information.
18
-
19
- :::
20
-
21
- ## Import
22
-
23
- ```tsx
24
- import { SyntaxHighlight } from "@lukoweb/apitogo/ui/SyntaxHighlight";
25
- ```
26
-
27
- ## Types
28
-
29
- ```ts
30
- type SyntaxHighlightProps = {
31
- language?: string;
32
- code?: string;
33
- wrapLines?: boolean;
34
- title?: string;
35
- showCopy?: "hover" | "always" | "never";
36
- showCopyText?: boolean;
37
- children?: string;
38
- showLanguageIndicator?: boolean;
39
- className?: string;
40
- showLineNumbers?: boolean;
41
- };
42
- ```
43
-
44
- ## Usage
45
-
46
- You can either use `children` or `code` prop to pass the code to the component.
47
-
48
- ```tsx
49
- <SyntaxHighlight language="typescript">
50
- {`for (let i = 0; i < Infinity; i++) {
51
- console.log(i);
52
- }`}
53
- </SyntaxHighlight>
54
- ```
55
-
56
- ## Result
57
-
58
- <SyntaxHighlight language="typescript">
59
- {`for (let i = 0; i < Infinity; i++) {
60
- console.log(i);
61
- }`}
62
- </SyntaxHighlight>
63
-
64
- ## Supported Languages
65
-
66
- Here are examples for all supported languages:
67
-
68
- ### TypeScript / JavaScript / TSX
69
-
70
- ```typescript title="User.ts"
71
- interface User {
72
- name: string;
73
- age: number;
74
- }
75
-
76
- const greet = (user: User): string => `Hello, ${user.name}!`;
77
- ```
78
-
79
- ```javascript title="fibonacci.js"
80
- function fibonacci(n) {
81
- if (n <= 1) return n;
82
- return fibonacci(n - 1) + fibonacci(n - 2);
83
- }
84
-
85
- console.log(fibonacci(10));
86
- ```
87
-
88
- ```tsx title="App.tsx"
89
- export const App = () => {
90
- return <div>Hello, World!</div>;
91
- };
92
- ```
93
-
94
- ### Markdown / MDX
95
-
96
- ```markdown title="hello.md"
97
- # Hello World
98
-
99
- This is **bold** and _italic_ text.
100
-
101
- - Item 1
102
- - Item 2
103
-
104
- [Link to APIToGo](https://apitogo.com)
105
- ```
106
-
107
- ```mdx title="welcome.mdx"
108
- import { Button } from "./Button";
109
-
110
- # Welcome to MDX
111
-
112
- <Button onClick={() => alert("Hello!")}>Click me</Button>
113
- ```
114
-
115
- ### JSON / YAML / TOML
116
-
117
- ```json title="package.json"
118
- {
119
- "name": "apitogo",
120
- "version": "1.0.0",
121
- "scripts": {
122
- "dev": "vite",
123
- "build": "vite build"
124
- }
125
- }
126
- ```
127
-
128
- ```yaml title="package.yml"
129
- name: apitogo
130
- version: 1.0.0
131
- scripts:
132
- dev: vite
133
- build: vite build
134
- ```
135
-
136
- ```toml title="package.toml"
137
- [package]
138
- name = "apitogo"
139
- version = "1.0.0"
140
-
141
- [dependencies]
142
- react = "^19.0.0"
143
- ```
144
-
145
- ### Shell / Bash / Terminal
146
-
147
- ```bash title="build.sh"
148
- #!/bin/bash
149
-
150
- # Install and build
151
- npm install
152
-
153
- if [ "$NODE_ENV" = "production" ]; then
154
- npm run build
155
- else
156
- npm run dev
157
- fi
158
- ```
159
-
160
- ```ansi title=ANSI
161
- $ pnpm run build
162
-
163
- > apitogo@1.0.0 build
164
-
165
- vite v7.0.5 building for production...
166
- ✓ 34 modules transformed.
167
- dist/index.html 0.46 kB │ gzip: 0.30 kB
168
- dist/assets/index-4sK2hL.css 24.67 kB │ gzip: 4.72 kB
169
- dist/assets/index-B1tPwS.js 143.18 kB │ gzip: 46.13 kB
170
- ✓ built in 1.23s
171
- ```
172
-
173
- ### GraphQL
174
-
175
- ```graphql title="schema.graphql"
176
- type User {
177
- id: ID!
178
- name: String!
179
- email: String!
180
- }
181
-
182
- type Query {
183
- user(id: ID!): User
184
- users: [User!]!
185
- }
186
-
187
- type Mutation {
188
- createUser(name: String!, email: String!): User!
189
- }
190
- ```
191
-
192
- ### Python
193
-
194
- ```python title="data_processor.py"
195
- import asyncio
196
- from typing import List, Optional
197
-
198
- class DataProcessor:
199
- def __init__(self, name: str):
200
- self.name = name
201
-
202
- async def process_items(self, items: List[str]) -> dict:
203
- results = [await self._process(item) for item in items]
204
- return {"processed": len(results), "items": results}
205
- ```
206
-
207
- ### C#
208
-
209
- ```csharp title="user_service.cs"
210
- using System;
211
- using System.Linq;
212
-
213
- public class UserService {
214
- private readonly List<User> _users = new();
215
-
216
- public async Task<User?> GetUserAsync(int id) {
217
- await Task.Delay(100);
218
- return _users.FirstOrDefault(u => u.Id == id);
219
- }
220
- }
221
- ```
222
-
223
- ### Rust
224
-
225
- ```rust title="main.rs"
226
- use std::collections::HashMap;
227
-
228
- fn main() {
229
- let mut scores = HashMap::new();
230
- scores.insert(String::from("Blue"), 10);
231
- scores.insert(String::from("Red"), 50);
232
-
233
- println!("Team scores: {:?}", scores);
234
- }
235
- ```
236
-
237
- ### Ruby
238
-
239
- ```ruby title="todo_list.rb"
240
- class TodoList
241
- attr_reader :name, :items
242
-
243
- def initialize(name)
244
- @name = name
245
- @items = []
246
- end
247
-
248
- def add_item(description)
249
- @items << { description: description, completed: false }
250
- end
251
- end
252
- ```
253
-
254
- ### PHP
255
-
256
- ```php title="user.php"
257
- <?php
258
- class User {
259
- public function __construct(
260
- public readonly int $id,
261
- public readonly string $name,
262
- public readonly string $email
263
- ) {}
264
-
265
- public function getDisplayName(): string {
266
- return ucfirst($this->name);
267
- }
268
- }
269
- ```
270
-
271
- ### HTML
272
-
273
- <!-- prettier-ignore -->
274
- ```html title="index.html"
275
- <!DOCTYPE html>
276
- <html lang="en">
277
- <head>
278
- <meta charset="UTF-8" />
279
- <title>APIToGo Example</title>
280
- </head>
281
- <body>
282
- <h1>Welcome to APIToGo</h1>
283
- <p>Build beautiful documentation sites with ease.</p>
284
- <p>
285
- Nunc nec ornare libero. Sed ultricies lorem vitae enim vestibulum, at posuere augue ullamcorper.
286
- </p>
287
- </body>
288
- </html>
289
- ```
290
-
291
- ### CSS
292
-
293
- ```css title="styles.css"
294
- .button {
295
- background-color: #007bff;
296
- color: white;
297
- padding: 0.5rem 1rem;
298
- border: none;
299
- border-radius: 0.25rem;
300
- cursor: pointer;
301
- }
302
-
303
- .button:hover {
304
- background-color: #0056b3;
305
- }
306
- ```
307
-
308
- ### Java
309
-
310
- ```java title="user_service.java"
311
- import java.util.List;
312
- import java.util.stream.Collectors;
313
-
314
- public class UserService {
315
- private List<User> users;
316
-
317
- public List<User> getActiveUsers() {
318
- return users.stream()
319
- .filter(User::isActive)
320
- .collect(Collectors.toList());
321
- }
322
- }
323
- ```
324
-
325
- ### Go
326
-
327
- ```go title="main.go"
328
- package main
329
-
330
- import "fmt"
331
-
332
- type User struct {
333
- ID int
334
- Name string
335
- Email string
336
- }
337
-
338
- func main() {
339
- user := User{ID: 1, Name: "Alice", Email: "alice@example.com"}
340
- fmt.Printf("User: %+v\n", user)
341
- }
342
- ```
343
-
344
- ### Kotlin
345
-
346
- ```kotlin title="user.kt"
347
- data class User(val id: Long, val name: String, val email: String)
348
-
349
- class UserRepository {
350
- private val users = mutableListOf<User>()
351
-
352
- fun addUser(user: User) {
353
- users.add(user)
354
- }
355
-
356
- fun findById(id: Long): User? = users.find { it.id == id }
357
- }
358
- ```
359
-
360
- ### Objective-C
361
-
362
- ```objc title="user.m"
363
- #import <Foundation/Foundation.h>
364
-
365
- @interface User : NSObject
366
- @property (nonatomic, strong) NSString *name;
367
- @property (nonatomic, strong) NSString *email;
368
- @property (nonatomic, assign) NSInteger userId;
369
-
370
- - (instancetype)initWithName:(NSString *)name
371
- email:(NSString *)email
372
- userId:(NSInteger)userId;
373
- @end
374
- ```
375
-
376
- ### Swift
377
-
378
- ```swift title="user.swift"
379
- import Foundation
380
-
381
- struct User: Codable {
382
- let id: UUID
383
- let name: String
384
- let email: String
385
-
386
- init(name: String, email: String) {
387
- self.id = UUID()
388
- self.name = name
389
- self.email = email
390
- }
391
- }
392
- ```
393
-
394
- ### XML
395
-
396
- ```xml title="app.xml"
397
- <?xml version="1.0" encoding="UTF-8"?>
398
- <configuration>
399
- <appSettings>
400
- <add key="ApplicationName" value="APIToGo" />
401
- <add key="Version" value="1.0.0" />
402
- </appSettings>
403
- <modules>
404
- <module name="Auth" enabled="true" />
405
- <module name="Logging" enabled="true" />
406
- </modules>
407
- </configuration>
408
- ```
409
-
410
- ### C
411
-
412
- ```c title="hello.c"
413
- #include <stdio.h>
414
- #include <stdlib.h>
415
-
416
- typedef struct {
417
- int id;
418
- char name[50];
419
- } User;
420
-
421
- int main() {
422
- User user = {1, "Alice"};
423
- printf("User: %s (ID: %d)\n", user.name, user.id);
424
- return 0;
425
- }
426
- ```
427
-
428
- ### C++
429
-
430
- ```cpp title="user.cpp"
431
- #include <iostream>
432
- #include <string>
433
- #include <vector>
434
-
435
- class User {
436
- private:
437
- int id;
438
- std::string name;
439
-
440
- public:
441
- User(int id, std::string name) : id(id), name(name) {}
442
-
443
- void display() const {
444
- std::cout << "User: " << name << " (ID: " << id << ")" << std::endl;
445
- }
446
- };
447
-
448
- int main() {
449
- User user(1, "Alice");
450
- user.display();
451
- return 0;
452
- }
453
- ```
454
-
455
- ### Zig
456
-
457
- ```zig title="main.zig"
458
- const std = @import("std");
459
-
460
- const User = struct {
461
- id: u32,
462
- name: []const u8,
463
-
464
- pub fn display(self: User) void {
465
- std.debug.print("User: {s} (ID: {})\n", .{ self.name, self.id });
466
- }
467
- };
468
-
469
- pub fn main() !void {
470
- const user = User{ .id = 1, .name = "Alice" };
471
- user.display();
472
- }
473
- ```
474
-
475
- ### Scala
476
-
477
- ```scala title="User.scala"
478
- case class User(id: Int, name: String, email: String)
479
-
480
- object UserRepository {
481
- private var users = List[User]()
482
-
483
- def addUser(user: User): Unit = {
484
- users = user :: users
485
- }
486
-
487
- def findById(id: Int): Option[User] = {
488
- users.find(_.id == id)
489
- }
490
- }
491
- ```
492
-
493
- ### Dart
494
-
495
- ```dart title="user.dart"
496
- class User {
497
- final int id;
498
- final String name;
499
- final String email;
500
-
501
- User({required this.id, required this.name, required this.email});
502
-
503
- factory User.fromJson(Map<String, dynamic> json) {
504
- return User(
505
- id: json['id'],
506
- name: json['name'],
507
- email: json['email'],
508
- );
509
- }
510
-
511
- Map<String, dynamic> toJson() => {
512
- 'id': id,
513
- 'name': name,
514
- 'email': email,
515
- };
516
- }
517
- ```
518
-
519
- ### Elixir
520
-
521
- ```elixir title="user.ex"
522
- defmodule User do
523
- defstruct [:id, :name, :email]
524
-
525
- def new(id, name, email) do
526
- %User{id: id, name: name, email: email}
527
- end
528
-
529
- def display(%User{name: name, id: id}) do
530
- IO.puts("User: #{name} (ID: #{id})")
531
- end
532
- end
533
-
534
- # Usage
535
- user = User.new(1, "Alice", "alice@example.com")
536
- User.display(user)
537
- ```
538
-
539
- ### OCaml
540
-
541
- ```ocaml title="user.ml"
542
- type user = {
543
- id : int;
544
- name : string;
545
- email : string;
546
- }
547
-
548
- let create_user id name email =
549
- { id; name; email }
550
-
551
- let display_user user =
552
- Printf.printf "User: %s (ID: %d)\n" user.name user.id
553
-
554
- let () =
555
- let user = create_user 1 "Alice" "alice@example.com" in
556
- display_user user
557
- ```
558
-
559
- ### Common Lisp
560
-
561
- ```lisp title="user.lisp"
562
- (defstruct user
563
- id
564
- name
565
- email)
566
-
567
- (defun create-user (id name email)
568
- (make-user :id id :name name :email email))
569
-
570
- (defun display-user (user)
571
- (format t "User: ~A (ID: ~A)~%"
572
- (user-name user)
573
- (user-id user)))
574
-
575
- ;; Usage
576
- (let ((user (create-user 1 "Alice" "alice@example.com")))
577
- (display-user user))
578
- ```
579
-
580
- ### PowerShell
581
-
582
- ```powershell title="user.ps1"
583
- class User {
584
- [int]$Id
585
- [string]$Name
586
- [string]$Email
587
-
588
- User([int]$id, [string]$name, [string]$email) {
589
- $this.Id = $id
590
- $this.Name = $name
591
- $this.Email = $email
592
- }
593
-
594
- [void]Display() {
595
- Write-Host "User: $($this.Name) (ID: $($this.Id))"
596
- }
597
- }
598
-
599
- # Usage
600
- $user = [User]::new(1, "Alice", "alice@example.com")
601
- $user.Display()
602
- ```
1
+ ---
2
+ title: Syntax Highlight
3
+ sidebar_icon: code
4
+ ---
5
+
6
+ import { SyntaxHighlight } from "@lukoweb/apitogo/ui/SyntaxHighlight";
7
+ import { Callout } from "@lukoweb/apitogo/ui/Callout";
8
+
9
+ Add syntax highlighting to your code blocks with customizable styling and features. The component
10
+ offers extensive customization options including line numbers, copy buttons, language indicators,
11
+ and custom theming to match your brand. For simpler use cases, you can also use standard Markdown
12
+ code blocks as described in [Code Blocks](/docs/markdown/code-blocks).
13
+
14
+ :::tip
15
+
16
+ You can also use backticks to highlight code blocks in Markdown files, see
17
+ [Code Blocks](../markdown/code-blocks) for more information.
18
+
19
+ :::
20
+
21
+ ## Import
22
+
23
+ ```tsx
24
+ import { SyntaxHighlight } from "@lukoweb/apitogo/ui/SyntaxHighlight";
25
+ ```
26
+
27
+ ## Types
28
+
29
+ ```ts
30
+ type SyntaxHighlightProps = {
31
+ language?: string;
32
+ code?: string;
33
+ wrapLines?: boolean;
34
+ title?: string;
35
+ showCopy?: "hover" | "always" | "never";
36
+ showCopyText?: boolean;
37
+ children?: string;
38
+ showLanguageIndicator?: boolean;
39
+ className?: string;
40
+ showLineNumbers?: boolean;
41
+ };
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ You can either use `children` or `code` prop to pass the code to the component.
47
+
48
+ ```tsx
49
+ <SyntaxHighlight language="typescript">
50
+ {`for (let i = 0; i < Infinity; i++) {
51
+ console.log(i);
52
+ }`}
53
+ </SyntaxHighlight>
54
+ ```
55
+
56
+ ## Result
57
+
58
+ <SyntaxHighlight language="typescript">
59
+ {`for (let i = 0; i < Infinity; i++) {
60
+ console.log(i);
61
+ }`}
62
+ </SyntaxHighlight>
63
+
64
+ ## Supported Languages
65
+
66
+ Here are examples for all supported languages:
67
+
68
+ ### TypeScript / JavaScript / TSX
69
+
70
+ ```typescript title="User.ts"
71
+ interface User {
72
+ name: string;
73
+ age: number;
74
+ }
75
+
76
+ const greet = (user: User): string => `Hello, ${user.name}!`;
77
+ ```
78
+
79
+ ```javascript title="fibonacci.js"
80
+ function fibonacci(n) {
81
+ if (n <= 1) return n;
82
+ return fibonacci(n - 1) + fibonacci(n - 2);
83
+ }
84
+
85
+ console.log(fibonacci(10));
86
+ ```
87
+
88
+ ```tsx title="App.tsx"
89
+ export const App = () => {
90
+ return <div>Hello, World!</div>;
91
+ };
92
+ ```
93
+
94
+ ### Markdown / MDX
95
+
96
+ ```markdown title="hello.md"
97
+ # Hello World
98
+
99
+ This is **bold** and _italic_ text.
100
+
101
+ - Item 1
102
+ - Item 2
103
+
104
+ [Link to APIToGo](https://apitogo.com)
105
+ ```
106
+
107
+ ```mdx title="welcome.mdx"
108
+ import { Button } from "./Button";
109
+
110
+ # Welcome to MDX
111
+
112
+ <Button onClick={() => alert("Hello!")}>Click me</Button>
113
+ ```
114
+
115
+ ### JSON / YAML / TOML
116
+
117
+ ```json title="package.json"
118
+ {
119
+ "name": "apitogo",
120
+ "version": "1.0.0",
121
+ "scripts": {
122
+ "dev": "vite",
123
+ "build": "vite build"
124
+ }
125
+ }
126
+ ```
127
+
128
+ ```yaml title="package.yml"
129
+ name: apitogo
130
+ version: 1.0.0
131
+ scripts:
132
+ dev: vite
133
+ build: vite build
134
+ ```
135
+
136
+ ```toml title="package.toml"
137
+ [package]
138
+ name = "apitogo"
139
+ version = "1.0.0"
140
+
141
+ [dependencies]
142
+ react = "^19.0.0"
143
+ ```
144
+
145
+ ### Shell / Bash / Terminal
146
+
147
+ ```bash title="build.sh"
148
+ #!/bin/bash
149
+
150
+ # Install and build
151
+ npm install
152
+
153
+ if [ "$NODE_ENV" = "production" ]; then
154
+ npm run build
155
+ else
156
+ npm run dev
157
+ fi
158
+ ```
159
+
160
+ ```ansi title=ANSI
161
+ $ pnpm run build
162
+
163
+ > apitogo@1.0.0 build
164
+
165
+ vite v7.0.5 building for production...
166
+ ✓ 34 modules transformed.
167
+ dist/index.html 0.46 kB │ gzip: 0.30 kB
168
+ dist/assets/index-4sK2hL.css 24.67 kB │ gzip: 4.72 kB
169
+ dist/assets/index-B1tPwS.js 143.18 kB │ gzip: 46.13 kB
170
+ ✓ built in 1.23s
171
+ ```
172
+
173
+ ### GraphQL
174
+
175
+ ```graphql title="schema.graphql"
176
+ type User {
177
+ id: ID!
178
+ name: String!
179
+ email: String!
180
+ }
181
+
182
+ type Query {
183
+ user(id: ID!): User
184
+ users: [User!]!
185
+ }
186
+
187
+ type Mutation {
188
+ createUser(name: String!, email: String!): User!
189
+ }
190
+ ```
191
+
192
+ ### Python
193
+
194
+ ```python title="data_processor.py"
195
+ import asyncio
196
+ from typing import List, Optional
197
+
198
+ class DataProcessor:
199
+ def __init__(self, name: str):
200
+ self.name = name
201
+
202
+ async def process_items(self, items: List[str]) -> dict:
203
+ results = [await self._process(item) for item in items]
204
+ return {"processed": len(results), "items": results}
205
+ ```
206
+
207
+ ### C#
208
+
209
+ ```csharp title="user_service.cs"
210
+ using System;
211
+ using System.Linq;
212
+
213
+ public class UserService {
214
+ private readonly List<User> _users = new();
215
+
216
+ public async Task<User?> GetUserAsync(int id) {
217
+ await Task.Delay(100);
218
+ return _users.FirstOrDefault(u => u.Id == id);
219
+ }
220
+ }
221
+ ```
222
+
223
+ ### Rust
224
+
225
+ ```rust title="main.rs"
226
+ use std::collections::HashMap;
227
+
228
+ fn main() {
229
+ let mut scores = HashMap::new();
230
+ scores.insert(String::from("Blue"), 10);
231
+ scores.insert(String::from("Red"), 50);
232
+
233
+ println!("Team scores: {:?}", scores);
234
+ }
235
+ ```
236
+
237
+ ### Ruby
238
+
239
+ ```ruby title="todo_list.rb"
240
+ class TodoList
241
+ attr_reader :name, :items
242
+
243
+ def initialize(name)
244
+ @name = name
245
+ @items = []
246
+ end
247
+
248
+ def add_item(description)
249
+ @items << { description: description, completed: false }
250
+ end
251
+ end
252
+ ```
253
+
254
+ ### PHP
255
+
256
+ ```php title="user.php"
257
+ <?php
258
+ class User {
259
+ public function __construct(
260
+ public readonly int $id,
261
+ public readonly string $name,
262
+ public readonly string $email
263
+ ) {}
264
+
265
+ public function getDisplayName(): string {
266
+ return ucfirst($this->name);
267
+ }
268
+ }
269
+ ```
270
+
271
+ ### HTML
272
+
273
+ <!-- prettier-ignore -->
274
+ ```html title="index.html"
275
+ <!DOCTYPE html>
276
+ <html lang="en">
277
+ <head>
278
+ <meta charset="UTF-8" />
279
+ <title>APIToGo Example</title>
280
+ </head>
281
+ <body>
282
+ <h1>Welcome to APIToGo</h1>
283
+ <p>Build beautiful documentation sites with ease.</p>
284
+ <p>
285
+ Nunc nec ornare libero. Sed ultricies lorem vitae enim vestibulum, at posuere augue ullamcorper.
286
+ </p>
287
+ </body>
288
+ </html>
289
+ ```
290
+
291
+ ### CSS
292
+
293
+ ```css title="styles.css"
294
+ .button {
295
+ background-color: #007bff;
296
+ color: white;
297
+ padding: 0.5rem 1rem;
298
+ border: none;
299
+ border-radius: 0.25rem;
300
+ cursor: pointer;
301
+ }
302
+
303
+ .button:hover {
304
+ background-color: #0056b3;
305
+ }
306
+ ```
307
+
308
+ ### Java
309
+
310
+ ```java title="user_service.java"
311
+ import java.util.List;
312
+ import java.util.stream.Collectors;
313
+
314
+ public class UserService {
315
+ private List<User> users;
316
+
317
+ public List<User> getActiveUsers() {
318
+ return users.stream()
319
+ .filter(User::isActive)
320
+ .collect(Collectors.toList());
321
+ }
322
+ }
323
+ ```
324
+
325
+ ### Go
326
+
327
+ ```go title="main.go"
328
+ package main
329
+
330
+ import "fmt"
331
+
332
+ type User struct {
333
+ ID int
334
+ Name string
335
+ Email string
336
+ }
337
+
338
+ func main() {
339
+ user := User{ID: 1, Name: "Alice", Email: "alice@example.com"}
340
+ fmt.Printf("User: %+v\n", user)
341
+ }
342
+ ```
343
+
344
+ ### Kotlin
345
+
346
+ ```kotlin title="user.kt"
347
+ data class User(val id: Long, val name: String, val email: String)
348
+
349
+ class UserRepository {
350
+ private val users = mutableListOf<User>()
351
+
352
+ fun addUser(user: User) {
353
+ users.add(user)
354
+ }
355
+
356
+ fun findById(id: Long): User? = users.find { it.id == id }
357
+ }
358
+ ```
359
+
360
+ ### Objective-C
361
+
362
+ ```objc title="user.m"
363
+ #import <Foundation/Foundation.h>
364
+
365
+ @interface User : NSObject
366
+ @property (nonatomic, strong) NSString *name;
367
+ @property (nonatomic, strong) NSString *email;
368
+ @property (nonatomic, assign) NSInteger userId;
369
+
370
+ - (instancetype)initWithName:(NSString *)name
371
+ email:(NSString *)email
372
+ userId:(NSInteger)userId;
373
+ @end
374
+ ```
375
+
376
+ ### Swift
377
+
378
+ ```swift title="user.swift"
379
+ import Foundation
380
+
381
+ struct User: Codable {
382
+ let id: UUID
383
+ let name: String
384
+ let email: String
385
+
386
+ init(name: String, email: String) {
387
+ self.id = UUID()
388
+ self.name = name
389
+ self.email = email
390
+ }
391
+ }
392
+ ```
393
+
394
+ ### XML
395
+
396
+ ```xml title="app.xml"
397
+ <?xml version="1.0" encoding="UTF-8"?>
398
+ <configuration>
399
+ <appSettings>
400
+ <add key="ApplicationName" value="APIToGo" />
401
+ <add key="Version" value="1.0.0" />
402
+ </appSettings>
403
+ <modules>
404
+ <module name="Auth" enabled="true" />
405
+ <module name="Logging" enabled="true" />
406
+ </modules>
407
+ </configuration>
408
+ ```
409
+
410
+ ### C
411
+
412
+ ```c title="hello.c"
413
+ #include <stdio.h>
414
+ #include <stdlib.h>
415
+
416
+ typedef struct {
417
+ int id;
418
+ char name[50];
419
+ } User;
420
+
421
+ int main() {
422
+ User user = {1, "Alice"};
423
+ printf("User: %s (ID: %d)\n", user.name, user.id);
424
+ return 0;
425
+ }
426
+ ```
427
+
428
+ ### C++
429
+
430
+ ```cpp title="user.cpp"
431
+ #include <iostream>
432
+ #include <string>
433
+ #include <vector>
434
+
435
+ class User {
436
+ private:
437
+ int id;
438
+ std::string name;
439
+
440
+ public:
441
+ User(int id, std::string name) : id(id), name(name) {}
442
+
443
+ void display() const {
444
+ std::cout << "User: " << name << " (ID: " << id << ")" << std::endl;
445
+ }
446
+ };
447
+
448
+ int main() {
449
+ User user(1, "Alice");
450
+ user.display();
451
+ return 0;
452
+ }
453
+ ```
454
+
455
+ ### Zig
456
+
457
+ ```zig title="main.zig"
458
+ const std = @import("std");
459
+
460
+ const User = struct {
461
+ id: u32,
462
+ name: []const u8,
463
+
464
+ pub fn display(self: User) void {
465
+ std.debug.print("User: {s} (ID: {})\n", .{ self.name, self.id });
466
+ }
467
+ };
468
+
469
+ pub fn main() !void {
470
+ const user = User{ .id = 1, .name = "Alice" };
471
+ user.display();
472
+ }
473
+ ```
474
+
475
+ ### Scala
476
+
477
+ ```scala title="User.scala"
478
+ case class User(id: Int, name: String, email: String)
479
+
480
+ object UserRepository {
481
+ private var users = List[User]()
482
+
483
+ def addUser(user: User): Unit = {
484
+ users = user :: users
485
+ }
486
+
487
+ def findById(id: Int): Option[User] = {
488
+ users.find(_.id == id)
489
+ }
490
+ }
491
+ ```
492
+
493
+ ### Dart
494
+
495
+ ```dart title="user.dart"
496
+ class User {
497
+ final int id;
498
+ final String name;
499
+ final String email;
500
+
501
+ User({required this.id, required this.name, required this.email});
502
+
503
+ factory User.fromJson(Map<String, dynamic> json) {
504
+ return User(
505
+ id: json['id'],
506
+ name: json['name'],
507
+ email: json['email'],
508
+ );
509
+ }
510
+
511
+ Map<String, dynamic> toJson() => {
512
+ 'id': id,
513
+ 'name': name,
514
+ 'email': email,
515
+ };
516
+ }
517
+ ```
518
+
519
+ ### Elixir
520
+
521
+ ```elixir title="user.ex"
522
+ defmodule User do
523
+ defstruct [:id, :name, :email]
524
+
525
+ def new(id, name, email) do
526
+ %User{id: id, name: name, email: email}
527
+ end
528
+
529
+ def display(%User{name: name, id: id}) do
530
+ IO.puts("User: #{name} (ID: #{id})")
531
+ end
532
+ end
533
+
534
+ # Usage
535
+ user = User.new(1, "Alice", "alice@example.com")
536
+ User.display(user)
537
+ ```
538
+
539
+ ### OCaml
540
+
541
+ ```ocaml title="user.ml"
542
+ type user = {
543
+ id : int;
544
+ name : string;
545
+ email : string;
546
+ }
547
+
548
+ let create_user id name email =
549
+ { id; name; email }
550
+
551
+ let display_user user =
552
+ Printf.printf "User: %s (ID: %d)\n" user.name user.id
553
+
554
+ let () =
555
+ let user = create_user 1 "Alice" "alice@example.com" in
556
+ display_user user
557
+ ```
558
+
559
+ ### Common Lisp
560
+
561
+ ```lisp title="user.lisp"
562
+ (defstruct user
563
+ id
564
+ name
565
+ email)
566
+
567
+ (defun create-user (id name email)
568
+ (make-user :id id :name name :email email))
569
+
570
+ (defun display-user (user)
571
+ (format t "User: ~A (ID: ~A)~%"
572
+ (user-name user)
573
+ (user-id user)))
574
+
575
+ ;; Usage
576
+ (let ((user (create-user 1 "Alice" "alice@example.com")))
577
+ (display-user user))
578
+ ```
579
+
580
+ ### PowerShell
581
+
582
+ ```powershell title="user.ps1"
583
+ class User {
584
+ [int]$Id
585
+ [string]$Name
586
+ [string]$Email
587
+
588
+ User([int]$id, [string]$name, [string]$email) {
589
+ $this.Id = $id
590
+ $this.Name = $name
591
+ $this.Email = $email
592
+ }
593
+
594
+ [void]Display() {
595
+ Write-Host "User: $($this.Name) (ID: $($this.Id))"
596
+ }
597
+ }
598
+
599
+ # Usage
600
+ $user = [User]::new(1, "Alice", "alice@example.com")
601
+ $user.Display()
602
+ ```