Skip to content

Commit d650b76

Browse files
committed
chore: version v0.0.4
Signed-off-by: Saulo Vallory <me@saulo.engineer>
1 parent e2df940 commit d650b76

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2735
-2325
lines changed

docs/changelog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Changelog"
33
description: "What's new in mint-tsdocs"
4-
icon: "clock-rotate-left"
4+
icon: history
55
---
66

77
# Changelog

docs/cheat-sheet.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ mint-tsdocs # Generate for current project
2828
mint-tsdocs ./packages/core # Generate for specific directory
2929

3030
# View information
31-
mint-tsdocs show config # Show current settings
32-
mint-tsdocs show stats # Show documentation statistics
31+
mint-tsdocs config # Show current settings
32+
mint-tsdocs coverage # Show documentation coverage
3333

3434
# Check documentation quality
3535
mint-tsdocs lint # Check for doc issues
@@ -159,10 +159,10 @@ mint-tsdocs
159159

160160
```bash
161161
# Show configuration
162-
mint-tsdocs show config
162+
mint-tsdocs config
163163

164-
# Show documentation statistics
165-
mint-tsdocs show stats
164+
# Show documentation coverage
165+
mint-tsdocs coverage
166166

167167
# Check documentation quality
168168
mint-tsdocs lint

docs/cli-reference.mdx

Lines changed: 12 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -163,44 +163,18 @@ mint-tsdocs customize -t ./templates --force
163163

164164
### show
165165

166-
Display configuration or documentation statistics.
166+
**[DEPRECATED]** This command is deprecated and will be removed in a future version.
167167

168168
**Usage:**
169169
```bash
170170
mint-tsdocs show [TARGET]
171171
```
172172

173-
**Targets:**
174-
- `config` - Display current configuration (default)
175-
- `stats` - Display documentation statistics
173+
**Migration:**
174+
- Use `mint-tsdocs config` instead of `mint-tsdocs show config`
175+
- Use `mint-tsdocs coverage` instead of `mint-tsdocs show stats`
176176

177-
**Examples:**
178-
```bash
179-
# Show current configuration
180-
mint-tsdocs show
181-
mint-tsdocs show config
182-
183-
# Show documentation statistics
184-
mint-tsdocs show stats
185-
```
186-
187-
**Config Output:**
188-
Shows all settings from `mint-tsdocs.config.json`:
189-
- Project settings (entry point, output folder)
190-
- Navigation settings (tab name, group name)
191-
- README conversion settings
192-
- Template configuration
193-
- API Extractor configuration
194-
- TSDoc configuration
195-
196-
**Stats Output:**
197-
Shows comprehensive documentation metrics:
198-
- **Project**: Package name
199-
- **API Surface Area**: Counts of classes, interfaces, functions, type aliases, enums, namespaces, variables, methods, and properties
200-
- **Documentation Coverage**: Documented vs undocumented items, items with examples/remarks, and overall coverage percentage (color-coded)
201-
- **Generated Files**: Number of MDX files, total size, average size, and output location
202-
203-
The stats command requires that documentation has been generated at least once.
177+
The `show` command currently redirects to the new commands automatically, but you should update your scripts to use the new commands directly.
204178

205179
---
206180

@@ -395,7 +369,7 @@ No installation required when using npx:
395369
npx mint-tsdocs
396370
npx mint-tsdocs generate
397371
npx mint-tsdocs ./packages/my-lib
398-
npx mint-tsdocs show stats
372+
npx mint-tsdocs coverage
399373
```
400374

401375
**package.json Scripts:**
@@ -501,10 +475,10 @@ npx mintlify dev
501475
### Debugging Issues
502476
```bash
503477
# Check current configuration
504-
mint-tsdocs show config
478+
mint-tsdocs config
505479

506-
# View documentation statistics
507-
mint-tsdocs show stats
480+
# View documentation coverage
481+
mint-tsdocs coverage
508482

509483
# Generate with debug output
510484
mint-tsdocs generate --debug
@@ -558,13 +532,13 @@ mint-tsdocs generate --debug
558532
ls -la lib/*.d.ts
559533

560534
# Verify entry point exists
561-
mint-tsdocs show config
535+
mint-tsdocs config
562536
```
563537

564538
### Documentation Issues
565539
```bash
566-
# View documentation statistics and coverage
567-
mint-tsdocs show stats
540+
# View documentation coverage
541+
mint-tsdocs coverage
568542

569543
# Clear cache by deleting .tsdocs/ directory
570544
rm -rf docs/.tsdocs

docs/components/custom-styles.mdx

Lines changed: 47 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ icon: "palette"
99
All Mint TSDocs components come with default styling that integrates seamlessly with Mintlify's design system. You can easily customize these styles to match your documentation's look and feel.
1010

1111
<Tip>
12-
Mint TSDocs uses CSS `@layer` for default styles, making them easy to override without `!important`.
12+
Mint TSDocs provides default styles that can be customized in your `style.css` file.
1313
</Tip>
1414

1515
## Available Components
1616

1717
Mint TSDocs provides the following components with customizable styles:
1818

1919
<CardGroup cols={2}>
20-
<Card title="RefLink" icon="link" href="/components/type-info#reflink">
20+
<Card title="RefLink" icon="link" href="/components/reflink">
2121
Type-safe links to API reference pages
2222
</Card>
23-
<Card title="PageLink" icon="file" href="/components/type-info#pagelink">
23+
<Card title="PageLink" icon="link" href="/components/pagelink">
2424
Type-safe links to documentation pages
2525
</Card>
26-
<Card title="TypeTree" icon="tree" href="/components/type-tree">
26+
<Card title="TypeTree" icon="diagram-project" href="/components/type-tree">
2727
Recursive type structure visualization
2828
</Card>
2929
<Card title="Preview" icon="eye" href="/components/preview">
@@ -97,31 +97,37 @@ TypeTree uses Mintlify's native `ResponseField` and `Expandable` components inte
9797
}
9898
```
9999

100-
## Using CSS Layers for Easy Overrides
100+
## Customizing Component Styles
101101

102-
Mint TSDocs default styles are defined in the `tsdocs-defaults` CSS layer. This means your custom styles will automatically take precedence without needing `!important`.
102+
Mint TSDocs includes a `tsdocs-styles.css` file that is automatically imported via `docs/style.css`. You can override these defaults by adding more specific selectors or using `!important`.
103103

104104
<Steps>
105-
<Step title="Create your style.css file">
106-
Create a `style.css` file in your docs root directory (e.g., `/docs/style.css`).
105+
<Step title="Locate your style.css file">
106+
Your `docs/style.css` file already imports the tsdocs styles:
107+
108+
```css docs/style.css
109+
@import url('./snippets/tsdocs/tsdocs-styles.css');
110+
```
107111

108112
<Note>
109-
Mintlify automatically loads any `.css` file from your docs directory - no configuration needed!
113+
Mintlify automatically loads `style.css` from your docs directory - no configuration needed!
110114
</Note>
111115
</Step>
112116

113117
<Step title="Add your custom styles">
114-
Write your styles using the component selectors above. They will automatically override the defaults.
118+
Add your overrides below the import statement. Use `!important` to ensure they take precedence:
115119

116120
```css docs/style.css
121+
@import url('./snippets/tsdocs/tsdocs-styles.css');
122+
117123
/* Override broken link styling */
118-
.tsdocs-reflink.broken-link {
119-
border-bottom: 3px solid orange;
124+
.prose .tsdocs-reflink.broken-link {
125+
border-bottom: 3px solid orange !important;
120126
background-color: rgba(255, 165, 0, 0.1);
121127
}
122128

123129
/* Customize PageLink hover effect */
124-
.tsdocs-pagelink:hover {
130+
.prose .tsdocs-pagelink:hover {
125131
text-decoration: underline;
126132
}
127133

@@ -155,19 +161,19 @@ By default, broken reference and page links are styled with:
155161
- Hover tooltip showing the error
156162

157163
```css
158-
/* Default broken link styles (in @layer tsdocs-defaults) */
159-
.prose a.tsdocs-reflink.broken-link,
160-
.prose a.tsdocs-pagelink.broken-link {
161-
border-bottom: 2px dotted #ef4444;
162-
color: #ef4444;
163-
text-decoration: wavy underline;
164+
/* Default broken link styles */
165+
.prose .tsdocs-reflink.broken-link,
166+
.prose .tsdocs-pagelink.broken-link {
167+
border-bottom: 2px dotted #ef4444 !important;
168+
color: #ef4444 !important;
169+
text-decoration: wavy underline !important;
164170
}
165171

166172
/* Dark mode variant */
167-
.dark .prose a.tsdocs-reflink.broken-link,
168-
.dark .prose a.tsdocs-pagelink.broken-link {
169-
border-bottom-color: #f87171;
170-
color: #f87171;
173+
.dark .prose .tsdocs-reflink.broken-link,
174+
.dark .prose .tsdocs-pagelink.broken-link {
175+
border-bottom-color: #f87171 !important;
176+
color: #f87171 !important;
171177
}
172178
```
173179

@@ -178,11 +184,11 @@ By default, broken reference and page links are styled with:
178184
Make broken links less prominent for production sites:
179185

180186
```css
181-
.tsdocs-reflink.broken-link,
182-
.tsdocs-pagelink.broken-link {
183-
border-bottom: 1px dashed #94a3b8;
184-
color: inherit;
185-
text-decoration: none;
187+
.prose .tsdocs-reflink.broken-link,
188+
.prose .tsdocs-pagelink.broken-link {
189+
border-bottom: 1px dashed #94a3b8 !important;
190+
color: inherit !important;
191+
text-decoration: none !important;
186192
}
187193
```
188194
</Accordion>
@@ -191,8 +197,8 @@ By default, broken reference and page links are styled with:
191197
Add hover effects to all Mint TSDocs links:
192198

193199
```css
194-
.tsdocs-reflink:hover,
195-
.tsdocs-pagelink:hover {
200+
.prose .tsdocs-reflink:hover,
201+
.prose .tsdocs-pagelink:hover {
196202
text-decoration: underline;
197203
opacity: 0.8;
198204
transition: opacity 0.2s ease;
@@ -299,23 +305,26 @@ Mintlify supports CSS variables for consistent theming. You can reference these
299305
**Maintain accessibility** - Ensure sufficient color contrast (use browser DevTools to check)
300306
</Check>
301307

302-
<Warning>
303-
Don't use `!important` unless absolutely necessary - the CSS layers system makes it unnecessary
304-
</Warning>
308+
<Tip>
309+
Use `!important` when overriding broken link styles to ensure your customizations take precedence
310+
</Tip>
305311

306312
## Next Steps
307313

308314
<CardGroup cols={2}>
309-
<Card title="Learn about TypeInfo" icon="info-circle" href="/components/type-info">
315+
<Card title="RefLink" icon="link" href="/components/reflink">
316+
Type-safe API reference links
317+
</Card>
318+
<Card title="PageLink" icon="link" href="/components/pagelink">
319+
Type-safe documentation page links
320+
</Card>
321+
<Card title="TypeInfo" icon="info-circle" href="/components/type-info">
310322
Auto-generated type information components
311323
</Card>
312-
<Card title="Explore TypeTree" icon="sitemap" href="/components/type-tree">
324+
<Card title="TypeTree" icon="diagram-project" href="/components/type-tree">
313325
Recursive type structure visualization
314326
</Card>
315327
<Card title="Mintlify Custom CSS" icon="paintbrush" href="https://mintlify.com/docs/customize/custom-scripts">
316328
Complete Mintlify CSS customization guide
317329
</Card>
318-
<Card title="CSS Layers Guide" icon="layer-group" href="https://developer.mozilla.org/en-US/docs/Web/CSS/@layer">
319-
Learn more about CSS @layer at MDN
320-
</Card>
321330
</CardGroup>

0 commit comments

Comments
 (0)