Skip to content

Commit cc0faaf

Browse files
author
Yann VR
committed
Enhance markdown and MDX compatibility with validation and fixing scripts
- Added scripts for validating and fixing markdown files to ensure compatibility with MDX parsers. - Introduced `validate-markdown.js` for comprehensive checks on common issues. - Created `fix-mdx-tags.js`, `fix-markdown.js`, and `fix-nested-emphasis.js` for targeted fixes. - Updated `package.json` and `README.md` to include new scripts and improve documentation. - Enhanced `package-lock.json` with new dependencies for markdown processing.
1 parent 33f27c8 commit cc0faaf

11 files changed

+1962
-12
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ npm install react@19 react-dom@19
5656

5757
[Install](#-installation)[Quick Start](#-quick-start)[Features](#-features)[Examples](#-examples)[Journey](#-journey)
5858

59-
</div>
60-
6159
---
6260

6361
## 🚀 Why peer-dependency-checker?
@@ -192,11 +190,11 @@ $ pdc recommend
192190
| Command | Description |
193191
|---------|-------------|
194192
| `pdc scan` | Analyze current project for upgrade opportunities |
195-
| `pdc check <packages>` | Test specific package upgrades for conflicts |
193+
| `pdc check \<packages\>` | Test specific package upgrades for conflicts |
196194
| `pdc analyze` | Deep analysis of all peer dependencies |
197195
| `pdc recommend` | Get smart upgrade recommendations |
198196
| `pdc outdated` | Enhanced version of `npm outdated` with compatibility |
199-
| `pdc why <package>` | Explain why a package can't be upgraded |
197+
| `pdc why \<package\>` | Explain why a package can't be upgraded |
200198

201199
## 🔧 Configuration
202200

@@ -240,7 +238,7 @@ peer-dependency-checker works out-of-the-box with **smart defaults**:
240238

241239
At **hyperdrift**, we believe in tools that make developers' lives easier, not harder. **peer-dependency-checker** was born from our frustration with tools that show you what *can* be upgraded, but not what *should* be upgraded safely.
242240

243-
> *"It's like having a senior developer review your upgrades before you break production."*
241+
*"It's like having a senior developer review your upgrades before you break production."*
244242

245243
## 📊 Journey
246244

RELEASE_NOTES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Ever had a major upgrade break your entire build because of peer dependency conf
1919

2020
#### 🧪 **Safe Testing Commands**
2121
- `pdc scan` - Analyze your project for upgrade opportunities
22-
- `pdc check <packages>` - Test specific package upgrades for conflicts
22+
- `pdc check \<packages\>` - Test specific package upgrades for conflicts
2323
- `pdc analyze` - Deep analysis of all peer dependencies
2424

2525
#### 🎨 **Beautiful Output**
@@ -75,7 +75,7 @@ $ pdc scan
7575

7676
At **hyperdrift**, we believe in tools that make developers' lives easier, not harder. This tool was born from our frustration with existing dependency tools that show you what *can* be upgraded, but not what *should* be upgraded safely.
7777

78-
> *"It's like having a senior developer review your upgrades before you break production."*
78+
*"It's like having a senior developer review your upgrades before you break production."*
7979

8080
### 🤝 Comparison with Existing Tools
8181

0 commit comments

Comments
 (0)