docyard 0.7.0 → 0.9.0
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.
- checksums.yaml +4 -4
- data/.rubocop.yml +5 -1
- data/CHANGELOG.md +43 -1
- data/lib/docyard/build/asset_bundler.rb +22 -7
- data/lib/docyard/build/file_copier.rb +49 -27
- data/lib/docyard/build/sitemap_generator.rb +6 -6
- data/lib/docyard/build/static_generator.rb +85 -12
- data/lib/docyard/builder.rb +6 -6
- data/lib/docyard/components/aliases.rb +12 -0
- data/lib/docyard/components/processors/abbreviation_processor.rb +72 -0
- data/lib/docyard/components/processors/accordion_processor.rb +81 -0
- data/lib/docyard/components/processors/badge_processor.rb +72 -0
- data/lib/docyard/components/processors/callout_processor.rb +8 -2
- data/lib/docyard/components/processors/cards_processor.rb +100 -0
- data/lib/docyard/components/processors/code_block_options_preprocessor.rb +23 -2
- data/lib/docyard/components/processors/code_block_processor.rb +6 -0
- data/lib/docyard/components/processors/code_group_processor.rb +198 -0
- data/lib/docyard/components/processors/code_snippet_import_preprocessor.rb +6 -1
- data/lib/docyard/components/processors/custom_anchor_processor.rb +42 -0
- data/lib/docyard/components/processors/file_tree_processor.rb +151 -0
- data/lib/docyard/components/processors/image_caption_processor.rb +96 -0
- data/lib/docyard/components/processors/include_processor.rb +86 -0
- data/lib/docyard/components/processors/steps_processor.rb +89 -0
- data/lib/docyard/components/processors/tabs_processor.rb +9 -1
- data/lib/docyard/components/processors/tooltip_processor.rb +57 -0
- data/lib/docyard/components/processors/video_embed_processor.rb +196 -0
- data/lib/docyard/components/support/code_group/html_builder.rb +122 -0
- data/lib/docyard/components/support/markdown_code_block_helper.rb +56 -0
- data/lib/docyard/config/branding_resolver.rb +121 -17
- data/lib/docyard/config/constants.rb +6 -4
- data/lib/docyard/config/logo_detector.rb +39 -0
- data/lib/docyard/config/validator.rb +122 -99
- data/lib/docyard/config.rb +40 -42
- data/lib/docyard/initializer.rb +15 -76
- data/lib/docyard/navigation/breadcrumb_builder.rb +133 -0
- data/lib/docyard/navigation/prev_next_builder.rb +4 -1
- data/lib/docyard/navigation/sidebar/children_discoverer.rb +51 -0
- data/lib/docyard/navigation/sidebar/config_parser.rb +136 -108
- data/lib/docyard/navigation/sidebar/file_resolver.rb +90 -0
- data/lib/docyard/navigation/sidebar/file_system_scanner.rb +2 -1
- data/lib/docyard/navigation/sidebar/item.rb +50 -7
- data/lib/docyard/navigation/sidebar/local_config_loader.rb +51 -0
- data/lib/docyard/navigation/sidebar/metadata_extractor.rb +71 -0
- data/lib/docyard/navigation/sidebar/metadata_reader.rb +51 -0
- data/lib/docyard/navigation/sidebar/path_prefixer.rb +34 -0
- data/lib/docyard/navigation/sidebar/renderer.rb +60 -38
- data/lib/docyard/navigation/sidebar/sorter.rb +21 -0
- data/lib/docyard/navigation/sidebar/tree_builder.rb +100 -26
- data/lib/docyard/navigation/sidebar/tree_filter.rb +55 -0
- data/lib/docyard/navigation/sidebar_builder.rb +105 -36
- data/lib/docyard/rendering/icon_helpers.rb +13 -0
- data/lib/docyard/rendering/icons/phosphor.rb +26 -1
- data/lib/docyard/rendering/markdown.rb +29 -1
- data/lib/docyard/rendering/renderer.rb +75 -34
- data/lib/docyard/rendering/template_resolver.rb +172 -0
- data/lib/docyard/routing/fallback_resolver.rb +92 -0
- data/lib/docyard/search/build_indexer.rb +1 -1
- data/lib/docyard/search/dev_indexer.rb +51 -6
- data/lib/docyard/search/pagefind_support.rb +2 -0
- data/lib/docyard/server/asset_handler.rb +25 -19
- data/lib/docyard/server/pagefind_handler.rb +63 -0
- data/lib/docyard/server/preview_server.rb +1 -1
- data/lib/docyard/server/rack_application.rb +81 -64
- data/lib/docyard/templates/assets/css/code.css +18 -51
- data/lib/docyard/templates/assets/css/components/abbreviation.css +86 -0
- data/lib/docyard/templates/assets/css/components/accordion.css +138 -0
- data/lib/docyard/templates/assets/css/components/badges.css +47 -0
- data/lib/docyard/templates/assets/css/components/banner.css +202 -0
- data/lib/docyard/templates/assets/css/components/breadcrumbs.css +143 -0
- data/lib/docyard/templates/assets/css/components/callout.css +67 -67
- data/lib/docyard/templates/assets/css/components/cards.css +100 -0
- data/lib/docyard/templates/assets/css/components/code-block.css +190 -282
- data/lib/docyard/templates/assets/css/components/code-group.css +281 -0
- data/lib/docyard/templates/assets/css/components/figure.css +22 -0
- data/lib/docyard/templates/assets/css/components/file-tree.css +124 -0
- data/lib/docyard/templates/assets/css/components/heading-anchor.css +36 -15
- data/lib/docyard/templates/assets/css/components/icon.css +0 -1
- data/lib/docyard/templates/assets/css/components/lightbox.css +65 -0
- data/lib/docyard/templates/assets/css/components/logo.css +0 -2
- data/lib/docyard/templates/assets/css/components/nav-menu.css +237 -0
- data/lib/docyard/templates/assets/css/components/navigation.css +193 -167
- data/lib/docyard/templates/assets/css/components/prev-next.css +68 -48
- data/lib/docyard/templates/assets/css/components/search.css +186 -174
- data/lib/docyard/templates/assets/css/components/steps.css +122 -0
- data/lib/docyard/templates/assets/css/components/tab-bar.css +163 -0
- data/lib/docyard/templates/assets/css/components/table-of-contents.css +127 -114
- data/lib/docyard/templates/assets/css/components/tabs.css +119 -160
- data/lib/docyard/templates/assets/css/components/theme-toggle.css +48 -44
- data/lib/docyard/templates/assets/css/components/tooltip.css +113 -0
- data/lib/docyard/templates/assets/css/components/video.css +41 -0
- data/lib/docyard/templates/assets/css/landing.css +815 -0
- data/lib/docyard/templates/assets/css/layout.css +489 -87
- data/lib/docyard/templates/assets/css/main.css +1 -3
- data/lib/docyard/templates/assets/css/markdown.css +113 -93
- data/lib/docyard/templates/assets/css/reset.css +0 -3
- data/lib/docyard/templates/assets/css/typography.css +43 -41
- data/lib/docyard/templates/assets/css/variables.css +268 -208
- data/lib/docyard/templates/assets/favicon.svg +7 -8
- data/lib/docyard/templates/assets/fonts/Inter-Variable.ttf +0 -0
- data/lib/docyard/templates/assets/js/components/abbreviation.js +85 -0
- data/lib/docyard/templates/assets/js/components/banner.js +81 -0
- data/lib/docyard/templates/assets/js/components/code-block.js +24 -42
- data/lib/docyard/templates/assets/js/components/code-group.js +283 -0
- data/lib/docyard/templates/assets/js/components/file-tree.js +39 -0
- data/lib/docyard/templates/assets/js/components/heading-anchor.js +26 -24
- data/lib/docyard/templates/assets/js/components/lightbox.js +72 -0
- data/lib/docyard/templates/assets/js/components/navigation.js +181 -70
- data/lib/docyard/templates/assets/js/components/search.js +0 -75
- data/lib/docyard/templates/assets/js/components/sidebar-toggle.js +29 -0
- data/lib/docyard/templates/assets/js/components/tab-navigation.js +145 -0
- data/lib/docyard/templates/assets/js/components/table-of-contents.js +153 -66
- data/lib/docyard/templates/assets/js/components/tabs.js +31 -69
- data/lib/docyard/templates/assets/js/components/tooltip.js +118 -0
- data/lib/docyard/templates/assets/js/theme.js +0 -3
- data/lib/docyard/templates/assets/logo-dark.svg +8 -2
- data/lib/docyard/templates/assets/logo.svg +7 -4
- data/lib/docyard/templates/config/docyard.yml.erb +37 -34
- data/lib/docyard/templates/errors/404.html.erb +1 -1
- data/lib/docyard/templates/errors/500.html.erb +1 -1
- data/lib/docyard/templates/layouts/default.html.erb +19 -67
- data/lib/docyard/templates/layouts/splash.html.erb +177 -0
- data/lib/docyard/templates/partials/_accordion.html.erb +9 -0
- data/lib/docyard/templates/partials/_banner.html.erb +27 -0
- data/lib/docyard/templates/partials/_breadcrumbs.html.erb +24 -0
- data/lib/docyard/templates/partials/_card.html.erb +23 -0
- data/lib/docyard/templates/partials/_code_block.html.erb +5 -3
- data/lib/docyard/templates/partials/_doc_footer.html.erb +25 -0
- data/lib/docyard/templates/partials/_features.html.erb +15 -0
- data/lib/docyard/templates/partials/_footer.html.erb +42 -0
- data/lib/docyard/templates/partials/_head.html.erb +22 -0
- data/lib/docyard/templates/partials/_header.html.erb +49 -0
- data/lib/docyard/templates/partials/_heading_anchor.html.erb +3 -1
- data/lib/docyard/templates/partials/_hero.html.erb +27 -0
- data/lib/docyard/templates/partials/_nav_group.html.erb +31 -11
- data/lib/docyard/templates/partials/_nav_leaf.html.erb +4 -1
- data/lib/docyard/templates/partials/_nav_menu.html.erb +42 -0
- data/lib/docyard/templates/partials/_nav_nested_section.html.erb +11 -0
- data/lib/docyard/templates/partials/_nav_section.html.erb +1 -1
- data/lib/docyard/templates/partials/_prev_next.html.erb +8 -2
- data/lib/docyard/templates/partials/_scripts.html.erb +7 -0
- data/lib/docyard/templates/partials/_search_modal.html.erb +2 -6
- data/lib/docyard/templates/partials/_search_trigger.html.erb +2 -6
- data/lib/docyard/templates/partials/_sidebar.html.erb +21 -4
- data/lib/docyard/templates/partials/_step.html.erb +14 -0
- data/lib/docyard/templates/partials/_tab_bar.html.erb +25 -0
- data/lib/docyard/templates/partials/_table_of_contents.html.erb +12 -12
- data/lib/docyard/templates/partials/_table_of_contents_toggle.html.erb +1 -3
- data/lib/docyard/templates/partials/_tabs.html.erb +2 -2
- data/lib/docyard/templates/partials/_theme_toggle.html.erb +2 -11
- data/lib/docyard/version.rb +1 -1
- metadata +70 -5
- data/lib/docyard/templates/markdown/getting-started/installation.md.erb +0 -77
- data/lib/docyard/templates/markdown/guides/configuration.md.erb +0 -202
- data/lib/docyard/templates/markdown/guides/markdown-features.md.erb +0 -247
- data/lib/docyard/templates/markdown/index.md.erb +0 -82
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
/* Nav Menu - Mobile dropdown navigation */
|
|
2
|
+
|
|
3
|
+
.nav-menu-btn {
|
|
4
|
+
display: none;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
/* Overlay */
|
|
8
|
+
.nav-menu-overlay {
|
|
9
|
+
position: fixed;
|
|
10
|
+
top: var(--header-height);
|
|
11
|
+
left: 0;
|
|
12
|
+
right: 0;
|
|
13
|
+
bottom: 0;
|
|
14
|
+
background: var(--overlay-bg);
|
|
15
|
+
backdrop-filter: blur(var(--overlay-blur));
|
|
16
|
+
z-index: var(--z-dropdown);
|
|
17
|
+
opacity: 0;
|
|
18
|
+
pointer-events: none;
|
|
19
|
+
transition: opacity 0.2s ease;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
.nav-menu-overlay.is-visible {
|
|
23
|
+
opacity: 1;
|
|
24
|
+
pointer-events: auto;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/* Dropdown container */
|
|
28
|
+
.nav-menu-dropdown {
|
|
29
|
+
position: fixed;
|
|
30
|
+
top: var(--header-height);
|
|
31
|
+
left: 0;
|
|
32
|
+
right: 0;
|
|
33
|
+
background: var(--background);
|
|
34
|
+
border-bottom: 1px solid var(--border);
|
|
35
|
+
z-index: calc(var(--z-dropdown) + 1);
|
|
36
|
+
transform: translateY(-8px);
|
|
37
|
+
opacity: 0;
|
|
38
|
+
pointer-events: none;
|
|
39
|
+
transition: transform 0.15s ease-out, opacity 0.15s ease-out;
|
|
40
|
+
box-shadow: var(--shadow-lg);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
.nav-menu-dropdown.is-open {
|
|
44
|
+
transform: translateY(0);
|
|
45
|
+
opacity: 1;
|
|
46
|
+
pointer-events: auto;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
.nav-menu-content {
|
|
50
|
+
max-width: var(--layout-max-width);
|
|
51
|
+
margin: 0 auto;
|
|
52
|
+
padding: var(--spacing-1) 0;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/* Navigation items */
|
|
56
|
+
.nav-menu-item {
|
|
57
|
+
display: flex;
|
|
58
|
+
align-items: center;
|
|
59
|
+
gap: var(--spacing-2);
|
|
60
|
+
width: 100%;
|
|
61
|
+
padding: var(--spacing-2) var(--spacing-4);
|
|
62
|
+
margin: 0 var(--spacing-2);
|
|
63
|
+
width: calc(100% - var(--spacing-4));
|
|
64
|
+
font-size: var(--text-sm);
|
|
65
|
+
font-weight: var(--font-medium);
|
|
66
|
+
color: var(--muted-foreground);
|
|
67
|
+
text-decoration: none;
|
|
68
|
+
background: transparent;
|
|
69
|
+
border: none;
|
|
70
|
+
border-radius: var(--radius-md);
|
|
71
|
+
cursor: pointer;
|
|
72
|
+
transition: background-color 0.1s ease, color 0.1s ease;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
.nav-menu-item:hover {
|
|
76
|
+
background: var(--muted);
|
|
77
|
+
color: var(--foreground);
|
|
78
|
+
text-decoration: none;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/* Active state */
|
|
82
|
+
.nav-menu-item.is-active {
|
|
83
|
+
background-color: oklch(from var(--primary) l c h / 10%);
|
|
84
|
+
color: var(--primary);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
.nav-menu-item.is-active:hover {
|
|
88
|
+
background-color: oklch(from var(--primary) l c h / 10%);
|
|
89
|
+
color: var(--primary);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
.nav-menu-item-icon {
|
|
93
|
+
display: inline-flex;
|
|
94
|
+
align-items: center;
|
|
95
|
+
flex-shrink: 0;
|
|
96
|
+
opacity: 0.7;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
.nav-menu-item-icon .docyard-icon {
|
|
100
|
+
width: 18px;
|
|
101
|
+
height: 18px;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
.nav-menu-item.is-active .nav-menu-item-icon {
|
|
105
|
+
opacity: 1;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
.nav-menu-item-text {
|
|
109
|
+
flex: 1;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
.nav-menu-item-external {
|
|
113
|
+
margin-left: auto;
|
|
114
|
+
width: 16px;
|
|
115
|
+
height: 16px;
|
|
116
|
+
opacity: 0.4;
|
|
117
|
+
flex-shrink: 0;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/* Divider */
|
|
121
|
+
.nav-menu-divider {
|
|
122
|
+
height: 1px;
|
|
123
|
+
background: var(--border);
|
|
124
|
+
margin: var(--spacing-2) var(--spacing-4);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/* CTAs in dropdown */
|
|
128
|
+
.nav-menu-ctas {
|
|
129
|
+
display: flex;
|
|
130
|
+
gap: var(--spacing-2);
|
|
131
|
+
padding: var(--spacing-2) var(--spacing-4);
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
.nav-menu-cta {
|
|
135
|
+
flex: 1;
|
|
136
|
+
display: flex;
|
|
137
|
+
align-items: center;
|
|
138
|
+
justify-content: center;
|
|
139
|
+
gap: var(--spacing-2);
|
|
140
|
+
padding: var(--spacing-2) var(--spacing-3);
|
|
141
|
+
font-size: var(--text-sm);
|
|
142
|
+
font-weight: var(--font-medium);
|
|
143
|
+
text-decoration: none;
|
|
144
|
+
border-radius: var(--radius-md);
|
|
145
|
+
border: 1px solid transparent;
|
|
146
|
+
cursor: pointer;
|
|
147
|
+
transition: background-color 0.2s ease, border-color 0.2s ease;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
.nav-menu-cta:hover {
|
|
151
|
+
text-decoration: none;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
.nav-menu-cta--secondary {
|
|
155
|
+
background: transparent;
|
|
156
|
+
color: var(--foreground);
|
|
157
|
+
border-color: var(--border);
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
.nav-menu-cta--secondary:hover {
|
|
161
|
+
background: var(--muted);
|
|
162
|
+
color: var(--foreground);
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
.nav-menu-cta--secondary:active {
|
|
166
|
+
opacity: 0.8;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
.nav-menu-cta--primary {
|
|
170
|
+
background: var(--primary);
|
|
171
|
+
color: var(--primary-foreground);
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
.nav-menu-cta--primary:hover {
|
|
175
|
+
background: oklch(from var(--primary) calc(l - 0.05) c h);
|
|
176
|
+
color: var(--primary-foreground);
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
.nav-menu-cta--primary:active {
|
|
180
|
+
background: oklch(from var(--primary) calc(l - 0.08) c h);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
.nav-menu-cta-arrow {
|
|
184
|
+
width: 16px;
|
|
185
|
+
height: 16px;
|
|
186
|
+
stroke-width: 2;
|
|
187
|
+
transition: transform 0.3s cubic-bezier(0.34, 1.56, 0.64, 1);
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
.nav-menu-cta--primary:hover .nav-menu-cta-arrow {
|
|
191
|
+
transform: translateX(3px);
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
/* Show on mobile only */
|
|
195
|
+
@media (max-width: 1024px) {
|
|
196
|
+
.nav-menu-btn {
|
|
197
|
+
display: flex;
|
|
198
|
+
align-items: center;
|
|
199
|
+
justify-content: center;
|
|
200
|
+
width: 2.25rem;
|
|
201
|
+
height: 2.25rem;
|
|
202
|
+
background: transparent;
|
|
203
|
+
border: none;
|
|
204
|
+
border-radius: var(--radius-md);
|
|
205
|
+
color: var(--muted-foreground);
|
|
206
|
+
cursor: pointer;
|
|
207
|
+
-webkit-appearance: none;
|
|
208
|
+
appearance: none;
|
|
209
|
+
transition: background-color 0.1s ease, color 0.1s ease;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
.nav-menu-btn:hover {
|
|
213
|
+
background: var(--muted);
|
|
214
|
+
color: var(--foreground);
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
.nav-menu-btn:focus-visible {
|
|
218
|
+
outline: none;
|
|
219
|
+
box-shadow: 0 0 0 2px var(--ring);
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
.nav-menu-btn svg {
|
|
223
|
+
width: 18px;
|
|
224
|
+
height: 18px;
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/* Reduced motion preference */
|
|
229
|
+
@media (prefers-reduced-motion: reduce) {
|
|
230
|
+
.nav-menu-overlay,
|
|
231
|
+
.nav-menu-dropdown,
|
|
232
|
+
.nav-menu-item,
|
|
233
|
+
.nav-menu-cta,
|
|
234
|
+
.nav-menu-cta-arrow {
|
|
235
|
+
transition: none;
|
|
236
|
+
}
|
|
237
|
+
}
|