index.blade.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. @php
  2. use Knuckles\Scribe\Tools\WritingUtils as u;
  3. @endphp
  4. <!doctype html>
  5. <html lang="en">
  6. <head>
  7. <meta charset="utf-8">
  8. <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
  9. <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
  10. <title>{!! $metadata['title'] !!}</title>
  11. <link href="https://fonts.googleapis.com/css?family=PT+Sans&display=swap" rel="stylesheet">
  12. <link rel="stylesheet" href="{!! $assetPathPrefix !!}css/theme-elements.style.css" media="screen">
  13. <script src="https://cdn.jsdelivr.net/npm/lodash@4.17.10/lodash.min.js"></script>
  14. <link rel="stylesheet" href="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/styles/docco.min.css">
  15. <script src="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/highlight.min.js"></script>
  16. <script>
  17. hljs.highlightAll();
  18. </script>
  19. <script type="module">
  20. import {
  21. CodeJar
  22. } from 'https://medv.io/codejar/codejar.js'
  23. window.CodeJar = CodeJar;
  24. </script>
  25. @if ($tryItOut['enabled'] ?? true)
  26. <script>
  27. var tryItOutBaseUrl = "{{ $tryItOut['base_url'] ?? config('app.url') }}";
  28. var useCsrf = Boolean({{ $tryItOut['use_csrf'] ?? null }});
  29. var csrfUrl = "{{ $tryItOut['csrf_url'] ?? null }}";
  30. </script>
  31. <script src="{{ u::getVersionedAsset($assetPathPrefix . 'js/tryitout.js') }}"></script>
  32. <style>
  33. .code-editor,
  34. .resp-content {
  35. color: whitesmoke;
  36. background-color: transparent;
  37. }
  38. /*
  39. Problem: we want syntax highlighting for the Try It Out JSON body code editor
  40. However, the Try It Out area uses a dark background, while request and response samples
  41. (which are already highlighted) use a light background. HighlightJS can only use one theme per document.
  42. Our options:
  43. 1. Change the bg of one. => No, it looks out of place on the page.
  44. 2. Use the same highlighting for both. => Nope, one would be unreadable.
  45. 3. Copy styles for a dark-bg h1js theme and prefix them for the CodeEditor, which is what we're doing.
  46. Since it's only JSON, we only need a few styles anyway.
  47. Styles taken from the Nord theme: https://github.com/highlightjs/highlight.js/blob/3997c9b430a568d5ad46d96693b90a74fc01ea7f/src/styles/nord.css#L2
  48. */
  49. .code-editor>.hljs-attr {
  50. color: #8FBCBB;
  51. }
  52. .code-editor>.hljs-string {
  53. color: #A3BE8C;
  54. }
  55. .code-editor>.hljs-number {
  56. color: #B48EAD;
  57. }
  58. .code-editor>.hljs-literal {
  59. color: #81A1C1;
  60. }
  61. </style>
  62. <script>
  63. function tryItOut(btnElement) {
  64. btnElement.disabled = true;
  65. let endpointId = btnElement.dataset.endpoint;
  66. let errorPanel = document.querySelector(`.tryItOut-error[data-endpoint=${endpointId}]`);
  67. errorPanel.hidden = true;
  68. let responsePanel = document.querySelector(`.tryItOut-response[data-endpoint=${endpointId}]`);
  69. responsePanel.hidden = true;
  70. let form = btnElement.form;
  71. let {
  72. method,
  73. path,
  74. hasjsonbody: hasJsonBody
  75. } = form.dataset;
  76. let body = {};
  77. if (hasJsonBody === "1") {
  78. body = form.querySelector('.code-editor').textContent;
  79. } else if (form.dataset.hasfiles === "1") {
  80. body = new FormData();
  81. form.querySelectorAll('input[data-component=body]')
  82. .forEach(el => {
  83. if (el.type === 'file') {
  84. if (el.files[0]) body.append(el.name, el.files[0])
  85. } else body.append(el.name, el.value);
  86. });
  87. } else {
  88. form.querySelectorAll('input[data-component=body]').forEach(el => {
  89. _.set(body, el.name, el.value);
  90. });
  91. }
  92. const urlParameters = form.querySelectorAll('input[data-component=url]');
  93. urlParameters.forEach(el => (path = path.replace(new RegExp(`\\{${el.name}\\??}`), el.value)));
  94. const headers = Object.fromEntries(Array.from(form.querySelectorAll('input[data-component=header]'))
  95. .map(el => [el.name, (el.dataset.prefix || '') + el.value]));
  96. const query = {}
  97. form.querySelectorAll('input[data-component=query]').forEach(el => {
  98. _.set(query, el.name, el.value);
  99. });
  100. let preflightPromise = Promise.resolve();
  101. if (window.useCsrf && window.csrfUrl) {
  102. preflightPromise = makeAPICall('GET', window.csrfUrl).then(() => {
  103. headers['X-XSRF-TOKEN'] = getCookie('XSRF-TOKEN');
  104. });
  105. }
  106. // content type has to be unset otherwise file upload won't work
  107. if (form.dataset.hasfiles === "1") {
  108. delete headers['Content-Type'];
  109. }
  110. return preflightPromise
  111. .then(() => makeAPICall(method, path, body, query, headers, endpointId))
  112. .catch(err => {
  113. console.error('API调用失败:', err);
  114. errorPanel.hidden = false;
  115. errorPanel.querySelector('.error-message').textContent =
  116. `请求失败: ${err.message}\n请确保服务器正在运行且配置正确`;
  117. })
  118. .finally(() => {
  119. btnElement.disabled = false;
  120. });
  121. }
  122. window.addEventListener('DOMContentLoaded', () => {
  123. document.querySelectorAll('.tryItOut-btn').forEach(el => {
  124. el.addEventListener('click', () => tryItOut(el));
  125. });
  126. })
  127. </script>
  128. @endif
  129. </head>
  130. <body>
  131. @if ($metadata['example_languages'])
  132. <script>
  133. function switchExampleLanguage(lang) {
  134. document.querySelectorAll(`.example-request`).forEach(el => el.style.display = 'none');
  135. document.querySelectorAll(`.example-request-${lang}`).forEach(el => el.style.display = 'initial');
  136. document.querySelectorAll(`.example-request-lang-toggle`).forEach(el => el.value = lang);
  137. }
  138. </script>
  139. @endif
  140. <script>
  141. function switchExampleResponse(endpointId, index) {
  142. document.querySelectorAll(`.example-response-${endpointId}`).forEach(el => el.style.display = 'none');
  143. document.querySelectorAll(`.example-response-${endpointId}-${index}`).forEach(el => el.style.display =
  144. 'initial');
  145. document.querySelectorAll(`.example-response-${endpointId}-toggle`).forEach(el => el.value = index);
  146. }
  147. /*
  148. * Requirement: a div with class `expansion-chevrons`
  149. * (or `expansion-chevrons-solid` to use the solid version).
  150. * Also add the `expanded` class if your div is expanded by default.
  151. */
  152. function toggleExpansionChevrons(evt) {
  153. let elem = evt.currentTarget;
  154. let chevronsArea = elem.querySelector('.expansion-chevrons');
  155. const solid = chevronsArea.classList.contains('expansion-chevrons-solid');
  156. const newState = chevronsArea.classList.contains('expanded') ? 'expand' : 'expanded';
  157. if (newState === 'expanded') {
  158. const selector = solid ? '#expanded-chevron-solid' : '#expanded-chevron';
  159. const template = document.querySelector(selector);
  160. const chevron = template.content.cloneNode(true);
  161. chevronsArea.replaceChildren(chevron);
  162. chevronsArea.classList.add('expanded');
  163. } else {
  164. const selector = solid ? '#expand-chevron-solid' : '#expand-chevron';
  165. const template = document.querySelector(selector);
  166. const chevron = template.content.cloneNode(true);
  167. chevronsArea.replaceChildren(chevron);
  168. chevronsArea.classList.remove('expanded');
  169. }
  170. }
  171. /**
  172. * 1. Make sure the children are inside the parent element
  173. * 2. Add `expandable` class to the parent
  174. * 3. Add `children` class to the children.
  175. * 4. Wrap the default chevron SVG in a div with class `expansion-chevrons`
  176. * (or `expansion-chevrons-solid` to use the solid version).
  177. * Also add the `expanded` class if your div is expanded by default.
  178. */
  179. function toggleElementChildren(evt) {
  180. let elem = evt.currentTarget;
  181. let children = elem.querySelector(`.children`);
  182. if (!children) return;
  183. if (children.contains(event.target)) return;
  184. let oldState = children.style.display
  185. if (oldState === 'none') {
  186. children.style.removeProperty('display');
  187. toggleExpansionChevrons(evt);
  188. } else {
  189. children.style.display = 'none';
  190. toggleExpansionChevrons(evt);
  191. }
  192. evt.stopPropagation();
  193. }
  194. function highlightSidebarItem(evt = null) {
  195. if (evt && evt.oldURL) {
  196. let oldHash = new URL(evt.oldURL).hash.slice(1);
  197. if (oldHash) {
  198. let previousItem = window['sidebar'].querySelector(`#toc-item-${oldHash}`);
  199. previousItem.classList.remove('sl-bg-primary-tint');
  200. previousItem.classList.add('sl-bg-canvas-100');
  201. }
  202. }
  203. let newHash = location.hash.slice(1);
  204. if (newHash) {
  205. let item = window['sidebar'].querySelector(`#toc-item-${newHash}`);
  206. item.classList.remove('sl-bg-canvas-100');
  207. item.classList.add('sl-bg-primary-tint');
  208. }
  209. }
  210. addEventListener('DOMContentLoaded', () => {
  211. highlightSidebarItem();
  212. document.querySelectorAll('.code-editor').forEach(elem => CodeJar(elem, (editor) => {
  213. // highlight.js does not trim old tags,
  214. // which means highlighting doesn't update on type (only on paste)
  215. // See https://github.com/antonmedv/codejar/issues/18
  216. editor.textContent = editor.textContent
  217. return hljs.highlightElement(editor)
  218. }));
  219. document.querySelectorAll('.expandable').forEach(el => {
  220. el.addEventListener('click', toggleElementChildren);
  221. });
  222. document.querySelectorAll('details').forEach(el => {
  223. el.addEventListener('toggle', toggleExpansionChevrons);
  224. });
  225. });
  226. addEventListener('hashchange', highlightSidebarItem);
  227. </script>
  228. <div class="sl-elements sl-antialiased sl-h-full sl-text-base sl-font-ui sl-text-body sl-flex sl-inset-0">
  229. @include('scribe::themes.elements.sidebar')
  230. <div class="sl-overflow-y-auto sl-flex-1 sl-w-full sl-px-16 sl-bg-canvas sl-py-16" style="max-width: 1500px;">
  231. <div class="sl-mb-10">
  232. <div class="sl-mb-4">
  233. <h1 class="sl-text-5xl sl-leading-tight sl-font-prose sl-font-semibold sl-text-heading">
  234. {!! $metadata['title'] !!}
  235. </h1>
  236. @if ($metadata['postman_collection_url'])
  237. <a title="Download Postman collection" class="sl-mx-1" href="{!! $metadata['postman_collection_url'] !!}"
  238. target="_blank">
  239. <small>Postman collection →</small>
  240. </a>
  241. @endif
  242. @if ($metadata['openapi_spec_url'])
  243. <a title="Download OpenAPI spec" class="sl-mx-1" href="{!! $metadata['openapi_spec_url'] !!}" target="_blank">
  244. <small>OpenAPI spec →</small>
  245. </a>
  246. @endif
  247. </div>
  248. <div class="sl-prose sl-markdown-viewer sl-my-4">
  249. {!! $intro !!}
  250. {!! $auth !!}
  251. </div>
  252. </div>
  253. @include('scribe::themes.elements.groups')
  254. <div class="sl-prose sl-markdown-viewer sl-my-5">
  255. {!! $append !!}
  256. </div>
  257. </div>
  258. </div>
  259. <template id="expand-chevron">
  260. <svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="chevron-right"
  261. class="svg-inline--fa fa-chevron-right fa-fw sl-icon sl-text-muted" xmlns="http://www.w3.org/2000/svg"
  262. viewBox="0 0 320 512">
  263. <path fill="currentColor"
  264. d="M96 480c-8.188 0-16.38-3.125-22.62-9.375c-12.5-12.5-12.5-32.75 0-45.25L242.8 256L73.38 86.63c-12.5-12.5-12.5-32.75 0-45.25s32.75-12.5 45.25 0l192 192c12.5 12.5 12.5 32.75 0 45.25l-192 192C112.4 476.9 104.2 480 96 480z">
  265. </path>
  266. </svg>
  267. </template>
  268. <template id="expanded-chevron">
  269. <svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="chevron-down"
  270. class="svg-inline--fa fa-chevron-down fa-fw sl-icon sl-text-muted" xmlns="http://www.w3.org/2000/svg"
  271. viewBox="0 0 448 512">
  272. <path fill="currentColor"
  273. d="M224 416c-8.188 0-16.38-3.125-22.62-9.375l-192-192c-12.5-12.5-12.5-32.75 0-45.25s32.75-12.5 45.25 0L224 338.8l169.4-169.4c12.5-12.5 32.75-12.5 45.25 0s12.5 32.75 0 45.25l-192 192C240.4 412.9 232.2 416 224 416z">
  274. </path>
  275. </svg>
  276. </template>
  277. <template id="expand-chevron-solid">
  278. <svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="caret-right"
  279. class="svg-inline--fa fa-caret-right fa-fw sl-icon" role="img" xmlns="http://www.w3.org/2000/svg"
  280. viewBox="0 0 256 512">
  281. <path fill="currentColor"
  282. d="M118.6 105.4l128 127.1C252.9 239.6 256 247.8 256 255.1s-3.125 16.38-9.375 22.63l-128 127.1c-9.156 9.156-22.91 11.9-34.88 6.943S64 396.9 64 383.1V128c0-12.94 7.781-24.62 19.75-29.58S109.5 96.23 118.6 105.4z">
  283. </path>
  284. </svg>
  285. </template>
  286. <template id="expanded-chevron-solid">
  287. <svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="caret-down"
  288. class="svg-inline--fa fa-caret-down fa-fw sl-icon" role="img" xmlns="http://www.w3.org/2000/svg"
  289. viewBox="0 0 320 512">
  290. <path fill="currentColor"
  291. d="M310.6 246.6l-127.1 128C176.4 380.9 168.2 384 160 384s-16.38-3.125-22.63-9.375l-127.1-128C.2244 237.5-2.516 223.7 2.438 211.8S19.07 192 32 192h255.1c12.94 0 24.62 7.781 29.58 19.75S319.8 237.5 310.6 246.6z">
  292. </path>
  293. </svg>
  294. </template>
  295. </body>
  296. </html>