Skip to content

Commit 5161d14

Browse files
Revert "feat: json-schema-based plugin doc with redesign"
This reverts commit 2e71d4c.
1 parent 2e71d4c commit 5161d14

13 files changed

+1396
-961
lines changed

assets/styles/_variable.scss

-10
Original file line numberDiff line numberDiff line change
@@ -203,16 +203,6 @@ $rem-10: 10rem;
203203
@import "bootstrap/scss/functions";
204204
@import "bootstrap/scss/variables";
205205
@import "bootstrap/scss/variables-dark";
206-
207-
$spacers: map-merge($spacers, (
208-
6: ($spacer * 2),
209-
7: ($spacer * 0.625)
210-
));
211-
212-
$font-sizes: map-merge($font-sizes, (
213-
7: ($font-size-base * 0.75)
214-
));
215-
216206
@import "bootstrap/scss/maps";
217207
@import "bootstrap/scss/mixins";
218208
@import "bootstrap/scss/utilities";

assets/styles/app.scss

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
@use "@kestra-io/ui-libs/src/scss/app.scss";
12
@import "variable";
23

34
html {

assets/styles/docs.scss

-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ $bd-gutter-x: 3rem;
4646

4747
p {
4848
color: $white;
49-
text-align: justify;
5049

5150
a {
5251
color: $purple-35;

assets/styles/theme.scss

-14
This file was deleted.

components/blueprints/Topology.client.vue

-6
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,7 @@
1010
</template>
1111

1212
<script setup>
13-
import { getCurrentInstance } from "vue";
1413
import TaskIcon from "../common/TaskIcon.vue";
15-
// Mock i18n for topology
16-
const currentInstance = getCurrentInstance()
17-
if (currentInstance) {
18-
currentInstance.appContext.config.globalProperties.$t = (key) => key
19-
}
2014
</script>
2115

2216
<script>

components/content/ProseCode.vue

+12-23
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,6 @@
2929
default: null
3030
}
3131
},
32-
components: {
33-
Mermaid
34-
},
3532
data() {
3633
return {
3734
icons: shallowRef({
@@ -79,10 +76,8 @@
7976
{{code}}
8077
</Mermaid>
8178
</template>
82-
<div class="code-block" @mouseover="hoverCode" @mouseleave="isHoveringCode = false" v-else>
83-
<div class="language" v-if="language && !isHoveringCode">
84-
{{ language }}
85-
</div>
79+
<div class="code-block mb-3" @mouseover="hoverCode" @mouseleave="isHoveringCode = false" v-else>
80+
<div class="language" v-if="language">{{ language }}</div>
8681
<template v-if="isHoveringCode">
8782
<button ref="copyButton" class="copy">
8883
<component
@@ -92,7 +87,7 @@
9287
</button>
9388
<div ref="copyTooltip" v-if="!!copyIconResetTimer" id="copied-tooltip" role="tooltip">
9489
Copied!
95-
<div id="arrow" data-popper-arrow />
90+
<div id="arrow" data-popper-arrow></div>
9691
</div>
9792
</template>
9893
<slot />
@@ -111,31 +106,25 @@
111106
position: relative;
112107
113108
.language {
114-
font-size: 0.75rem;
109+
position: absolute;
110+
right: 0.35rem;
111+
top: 0.25rem;
112+
color: var(--bs-gray-600);
113+
font-size: calc($font-size-base * .75);
115114
}
116115
117116
:deep(pre) {
118117
overflow: hidden;
119118
margin-bottom: 0;
120119
}
121120
122-
.language, .copy {
123-
color: var(--kestra-io-neutral-gray700) !important;
124-
position: absolute;
125-
top: 1.25rem;
126-
right: 1.25rem;
127-
}
128-
129121
.copy {
122+
position: absolute;
123+
right: 0;
124+
bottom: 0.1rem;
125+
color: $gray-600;
130126
border: none;
131127
background: none;
132-
133-
& .material-design-icon{
134-
&, & * {
135-
height: 1.125rem !important;
136-
width: 1.125rem !important;
137-
}
138-
}
139128
}
140129
141130
#copied-tooltip {

components/docs/RecursiveNavSidebar.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
}),
109109
methods: {
110110
pathToId(path) {
111-
return path.replaceAll("/", '_').replaceAll(".", "-")
111+
return path.replaceAll(/[/.]/g, '_')
112112
},
113113
filterChildren(item) {
114114
return (item.children || []).filter(r => item._path !== r._path);

components/layout/PluginContainer.vue

+7-128
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,11 @@
2525
<div class="bd-content">
2626
<DocsFeatureScopeMarker v-if="page.editions || page.version" :editions="page.editions"
2727
:version="page.version"/>
28-
<Suspense v-if="page.pluginType === 'definitions'">
29-
<SchemaToHtml class="plugin-schema" :schema="page.body.jsonSchema" :plugin-type="getPageName()">
30-
<template v-slot:markdown="{ content }">
31-
<MDC :value="content" />
32-
</template>
33-
</SchemaToHtml>
34-
</Suspense>
28+
<SchemaToHtml class="bd-markdown" :schema="page.body.jsonSchema" :plugin-type="getPageName()" :show-code-lang="true" :copyable-code="true" v-if="page.pluginType === 'definitions'">
29+
<template v-slot:markdown="{ content }">
30+
<MDC :value="content" tag="article" />
31+
</template>
32+
</SchemaToHtml>
3533
<ContentRendererMarkdown
3634
class="bd-markdown"
3735
:value="page"
@@ -226,7 +224,7 @@
226224
227225
:deep(p) {
228226
line-height: 1.75rem;
229-
font-size: $h6-font-size !important;
227+
font-size: $h6-font-size;
230228
}
231229
232230
:deep(.bd-markdown > h2) {
@@ -307,6 +305,7 @@
307305
padding: 0 calc($spacer / 4);
308306
}
309307
308+
310309
:deep(li > mark) {
311310
background-color: $link-color;
312311
}
@@ -345,124 +344,4 @@
345344
}
346345
}
347346
}
348-
349-
.plugin-schema {
350-
:deep(hr) {
351-
opacity: 1;
352-
border-top: calc(2 * var(--bs-border-width)) solid var(--kestra-io-token-color-border-secondary);
353-
}
354-
355-
:deep(article) {
356-
display: flex;
357-
flex-direction: column;
358-
gap: var(--spacer);
359-
}
360-
361-
:deep(.code-block) {
362-
background-color: var(--kestra-io-token-color-background-secondary);
363-
border: 1px solid var(--kestra-io-token-color-border-secondary);
364-
}
365-
366-
:deep(.language), :deep(.copy) {
367-
color: var(--kestra-io-neutral-gray700) !important;
368-
}
369-
370-
:deep(#copied-tooltip) {
371-
background: $gray-500;
372-
color: #fff;
373-
}
374-
375-
:deep(.plugin-section) {
376-
& .material-design-icon {
377-
&, & * {
378-
bottom: 0;
379-
}
380-
}
381-
382-
p {
383-
margin-bottom: 0;
384-
385-
& > code {
386-
color: var(--kestra-io-neutral-gray900);
387-
background-color: transparent !important;
388-
border: none;
389-
}
390-
}
391-
392-
.collapse-button {
393-
font-size: var(--font-size-lg);
394-
line-height: 1.5rem;
395-
color: var(--kestra-io-token-color-white);
396-
}
397-
398-
> .collapse-button {
399-
line-height: 2.375rem;
400-
401-
&:not(.collapsed) {
402-
color: var(--kestra-io-token-text-link-default);
403-
404-
& .material-design-icon {
405-
background-color: var(--kestra-io-neutral-gray400);
406-
}
407-
}
408-
}
409-
410-
.collapsible-body > .border {
411-
border-color: var(--kestra-io-token-color-border-secondary) !important;
412-
413-
> .property:not(:first-child) {
414-
border-top: var(--bs-border-width) var(--bs-border-style) var(--kestra-io-token-color-border-secondary);
415-
}
416-
417-
> * {
418-
background: var(--kestra-io-token-color-background-secondary);
419-
420-
&:not(:has(.collapse-button.collapsed)) {
421-
background: var(--kestra-io-token-color-background-primary);
422-
423-
> button {
424-
background: var(--kestra-io-neutral-gray300);
425-
outline: $spacer solid var(--kestra-io-neutral-gray300);
426-
}
427-
428-
.property-detail > *:first-child {
429-
border-top: none;
430-
}
431-
}
432-
}
433-
}
434-
435-
.property-detail {
436-
color: var(--kestra-io-token-color-white);
437-
438-
.property-description p {
439-
color: var(--kestra-io-neutral-gray700);
440-
}
441-
442-
> * {
443-
border-top: var(--bs-border-width) var(--bs-border-style) var(--kestra-io-token-color-border-secondary);
444-
}
445-
446-
.border:not(.type-box) {
447-
border-color: var(--kestra-io-neutral-gray500) !important;
448-
}
449-
}
450-
451-
.type-box{
452-
color: var(--kestra-io-token-color-white);
453-
454-
.ref-type {
455-
border-right: 1px solid var(--kestra-io-token-color-border-primary);
456-
}
457-
458-
&:has(.ref-type):hover {
459-
background: var(--kestra-io-token-color-background-hover-primary) !important;
460-
461-
.ref-type {
462-
border-right: 1px solid var(--ks-border-secondary);
463-
}
464-
}
465-
}
466-
}
467-
}
468347
</style>

middleware/route-lower-case.global.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export default defineNuxtRouteMiddleware((to, from) => {
44
return navigateTo(to.fullPath.replace(to.path, to.path.toLocaleLowerCase()), {redirectCode: 301})
55
}
66

7-
if (process.env.NODE_ENV === "production" && to.path !== "/" && to.path.endsWith("/")) {
7+
if (to.path !== "/" && to.path.endsWith("/")) {
88
return navigateTo(to.path.substring(0, to.path.length - 1), {redirectCode: 301});
99
}
1010
})

nuxt.config.ts

+3-8
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@ const DEFAULT_KESTRA_API_URL = 'https://api.kestra.io/v1';
55
export default defineNuxtConfig({
66
modules: ['@nuxt/devtools', '@nuxt/content', '@nuxt/image', '@nuxtjs/sitemap', 'nuxt-multi-cache', 'vue3-carousel-nuxt', 'nuxt-lazy-hydrate', '@nuxtjs/robots', 'nuxt-aos', '@zadigetvoltaire/nuxt-gtm'],
77
target: 'server',
8-
imports: {
9-
transform: {
10-
exclude: [/\bui-libs\b/]
11-
}
12-
},
138
image: {
149
formats: {
1510
webp: {
@@ -60,8 +55,7 @@ export default defineNuxtConfig({
6055

6156
css: [
6257
'@/assets/styles/vendor.scss',
63-
'@/assets/styles/app.scss',
64-
'@/assets/styles/theme.scss'
58+
'@/assets/styles/app.scss'
6559
],
6660

6761
content: {
@@ -129,6 +123,7 @@ export default defineNuxtConfig({
129123
}
130124
}
131125
},
126+
132127
vite: {
133128
build: {
134129
rollupOptions: {
@@ -337,4 +332,4 @@ export default defineNuxtConfig({
337332
},
338333

339334
compatibilityDate: '2024-07-16'
340-
})
335+
})

0 commit comments

Comments
 (0)