Skip to content

Commit 802c6ce

Browse files
committed
chore: css touch ups
1 parent 244dbbc commit 802c6ce

5 files changed

Lines changed: 201 additions & 81 deletions

File tree

docs/app.config.ts

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -98,22 +98,10 @@ export default defineConfig(
9898
},
9999
],
100100
sidebar: {
101-
"/guide": customFSSidebar("/guide", "Overview"),
102-
"/reference": customFSSidebar("/reference", "Reference"),
101+
"/guide": createFilesystemSidebar("/guide"),
102+
"/reference": createFilesystemSidebar("/reference"),
103103
},
104104
},
105105
},
106106
),
107107
);
108-
109-
function customFSSidebar(route: string, title: string) {
110-
const sidebar = createFilesystemSidebar(route);
111-
112-
return [
113-
{
114-
title,
115-
items: sidebar.filter((i) => !("items" in i)),
116-
},
117-
...sidebar.filter((i) => "items" in i),
118-
];
119-
}

docs/src/routes/guide/(4)deploy.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@ title: Deploy
44

55
# {frontmatter.title}
66

7-
A SolidBase app can be deployed anywhere a SolidStart app can be deployed. You can use [Nitro's](https://nitro.build/deploy) in your `app.config.ts` to add presets to deploy your app to various platforms.
8-
7+
A SolidBase app can be deployed anywhere a SolidStart app can be deployed. You can use [Nitro](https://nitro.build/deploy) in your `app.config.ts` to add presets to deploy your app to various platforms.

docs/src/routes/guide/features/(0)markdown.mdx

Lines changed: 197 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -71,93 +71,193 @@ You can automatically generate a table of contents (ToC) for your markdown files
7171

7272
Directives are custom blocks that can be used to highlight important information, warnings, tips, and more. They are similar to callouts or alerts in other documentation systems.
7373

74-
**Input**
7574

76-
```md
75+
:::::tab-group[features-demo-directives]
76+
::::tab[Markdown]
77+
````md
7778
:::info
7879
Highlights information that users should take into account, even when skimming.
7980
:::
81+
````
82+
::::
8083

81-
:::tip
82-
Optional information to help a user be more successful.
83-
:::
84-
85-
:::important
86-
Crucial information necessary for users to succeed.
87-
:::
88-
89-
:::warning
90-
Critical content demanding immediate user attention due to potential risks.
91-
:::
92-
93-
:::danger
94-
Negative potential consequences of an action.
95-
:::
96-
97-
:::details
98-
This is a details block.
99-
:::
100-
```
101-
102-
**Output**
84+
::::tab[HTML Output]
10385

10486
:::info
10587
Highlights information that users should take into account, even when skimming.
10688
:::
89+
::::
90+
:::::
91+
92+
:::::tab-group[features-demo-directives]
93+
::::tab[Markdown]
94+
````md
95+
:::tip
96+
Optional information to help a user be more successful.
97+
:::
98+
````
99+
::::
107100

101+
::::tab[HTML Output]
108102
:::tip
109103
Optional information to help a user be more successful.
110104
:::
105+
::::
106+
:::::
111107

108+
:::::tab-group[features-demo-directives]
109+
::::tab[Markdown]
110+
````md
112111
:::important
113112
Crucial information necessary for users to succeed.
114113
:::
114+
````
115+
::::
115116

117+
::::tab[HTML Output]
118+
:::important
119+
Crucial information necessary for users to succeed.
120+
:::
121+
::::
122+
:::::
123+
124+
:::::tab-group[features-demo-directives]
125+
::::tab[Markdown]
126+
````md
116127
:::warning
117128
Critical content demanding immediate user attention due to potential risks.
118129
:::
130+
````
131+
::::
132+
133+
::::tab[HTML Output]
134+
:::warning
135+
Critical content demanding immediate user attention due to potential risks.
136+
:::
137+
::::
138+
:::::
139+
140+
:::::tab-group[features-demo-directives]
141+
::::tab[Markdown]
142+
````md
143+
:::danger
144+
Negative potential consequences of an action.
145+
:::
146+
````
147+
::::
119148

149+
::::tab[HTML Output]
120150
:::danger
121151
Negative potential consequences of an action.
122152
:::
153+
::::
154+
:::::
123155

156+
157+
:::::tab-group[features-demo-directives]
158+
::::tab[Markdown]
159+
````md
124160
:::details
125161
This is a details block.
126162
:::
163+
````
164+
::::
165+
166+
::::tab[HTML Output]
167+
:::details
168+
This is a details block.
169+
:::
170+
::::
171+
:::::
127172

128173
### Custom Directive Titles
129174

130175
To set a custom title for a directive, use square brackets `[]` immediately after the directive type.
131176

132-
**Input**
133177

134-
```md
178+
:::::tab-group[features-demo-directives-titles]
179+
::::tab[Markdown]
180+
````md
135181
:::info[Custom Title]
136182
Highlights information that users should take into account, even when skimming.
137183
:::
184+
````
185+
::::
186+
187+
::::tab[HTML Output]
188+
:::info[Custom Title]
189+
Highlights information that users should take into account, even when skimming.
190+
:::
191+
::::
192+
:::::
193+
194+
195+
196+
:::::tab-group[features-demo-directives-titles]
197+
::::tab[Markdown]
198+
````md
199+
:::tip[]
200+
This is a tip with no title.
201+
:::
202+
````
203+
::::
138204

205+
::::tab[HTML Output]
139206
:::tip[]
140207
This is a tip with no title.
141208
:::
209+
::::
210+
:::::
211+
142212

213+
:::::tab-group[features-demo-directives-titles]
214+
::::tab[Markdown]
215+
````md
143216
:::details[Click me to view]
144217
This is a details block.
145218
:::
146-
```
219+
````
220+
::::
147221

148-
**Output**
222+
::::tab[HTML Output]
223+
:::details[Click me to view]
224+
This is a details block.
225+
:::
226+
::::
227+
:::::
149228

150-
:::info[Custom Title]
151-
Highlights information that users should take into account, even when skimming.
229+
## Tabs
230+
231+
::::::tab-group
232+
:::::tab[Markdown]
233+
234+
````mdx
235+
::::tab-group[key]
236+
:::tab[Title A]
237+
Hey I'm A
152238
:::
153239

154-
:::tip[]
155-
This is a tip with no title.
240+
:::tab[Title B]
241+
Hi this is B
156242
:::
243+
::::
244+
````
245+
:::::
157246

158-
:::details[Click me to view]
159-
This is a details block.
247+
:::::tab[HTML Output]
248+
::::tab-group
249+
:::tab[Title A]
250+
Hey I'm A
251+
:::
252+
253+
:::tab[Title B]
254+
Hi this is B
160255
:::
256+
::::
257+
:::::
258+
::::::
259+
260+
`[key]` is used for syncing and persistance.
161261

162262
## GitHub Flavored Markown
163263

@@ -167,59 +267,98 @@ In addition to the standard markdown syntax, SolidBase also supports several Git
167267

168268
In addition to the directives above, SolidBase also supports [GitHub-flavored alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts). These alerts can render as callouts with similar styles to the [directives above](#directives).
169269

170-
```md
270+
:::::tab-group[features-demo-directives-gfm]
271+
::::tab[Markdown]
272+
````md
171273
> [!NOTE]
172274
> Highlights information that users should take into account, even when skimming.
275+
````
276+
::::
173277

174-
> [!TIP]
175-
> Optional information to help a user be more successful.
176-
177-
> [!IMPORTANT]
178-
> Crucial information necessary for users to succeed.
179-
180-
> [!WARNING]
181-
> Critical content demanding immediate user attention due to potential risks.
182-
183-
> [!CAUTION]
184-
> Negative potential consequences of an action.
185-
```
186-
278+
::::tab[HTML Output]
187279
{/* prettier-ignore */}
188280
> [!NOTE]
189281
> Highlights information that users should take into account, even when skimming.
282+
::::
283+
:::::
284+
190285

286+
:::::tab-group[features-demo-directives-gfm]
287+
::::tab[Markdown]
288+
````md
289+
> [!TIP]
290+
> Optional information to help a user be more successful.
291+
````
292+
::::
293+
294+
::::tab[HTML Output]
191295
{/* prettier-ignore */}
192296
> [!TIP]
193297
> Optional information to help a user be more successful.
298+
::::
299+
:::::
300+
301+
:::::tab-group[features-demo-directives-gfm]
302+
::::tab[Markdown]
303+
````md
304+
> [!IMPORTANT]
305+
> Crucial information necessary for users to succeed.
306+
````
307+
::::
194308

309+
::::tab[HTML Output]
195310
{/* prettier-ignore */}
196311
> [!IMPORTANT]
197312
> Crucial information necessary for users to succeed.
313+
::::
314+
:::::
198315

316+
:::::tab-group[features-demo-directives-gfm]
317+
::::tab[Markdown]
318+
````md
319+
> [!WARNING]
320+
> Critical content demanding immediate user attention due to potential risks.
321+
322+
````
323+
::::
324+
325+
::::tab[HTML Output]
199326
{/* prettier-ignore */}
200327
> [!WARNING]
201328
> Critical content demanding immediate user attention due to potential risks.
329+
::::
330+
:::::
202331

332+
:::::tab-group[features-demo-directives-gfm]
333+
::::tab[Markdown]
334+
````md
335+
> [!CAUTION]
336+
> Negative potential consequences of an action.
337+
````
338+
::::
339+
340+
::::tab[HTML Output]
203341
{/* prettier-ignore */}
204342
> [!CAUTION]
205343
> Negative potential consequences of an action.
344+
::::
345+
:::::
206346

207347
### Autolinks
208348

209-
SolidBase is able to automatically detect and convert URLs into clickable links. This works for URLs containing the protocol (e.g., `https://example.com`) as well as those without (e.g., `www.example.com` or `example.com`).
210-
211-
**Input**
349+
SolidBase is able to automatically detect and convert URLs into clickable links.
212350

213-
```md
214-
start.solidjs.com
351+
::::tab-group
352+
:::tab[Markdown]
353+
````md
215354
https://github.com/kobaltedev/solidbase
216-
```
217-
218-
**Output**
219-
220-
start.solidjs.com
355+
````
356+
:::
221357

358+
:::tab[HTML Output]
222359
https://github.com/kobaltedev/solidbase
360+
:::
361+
::::
223362

224363
### Tables
225364

src/config/sidebar.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ export function createFilesystemSidebar<Item = SidebarItem>(
4444

4545
const resolvedOptions: Required<FilesystemSidebarOptions> = {
4646
filter: (item) => {
47-
console.log("AAAAAAAAA", item.matterData);
4847
return item.matterData?.excludeFromSidebar !== true;
4948
},
5049
sort: (a, b) => {

0 commit comments

Comments
 (0)