Skip to content

Commit 8405908

Browse files
committedMar 4, 2025·
Formatting
1 parent df1ca89 commit 8405908

File tree

2 files changed

+51
-65
lines changed

2 files changed

+51
-65
lines changed
 

‎packages/docs/src/content/docs/index.mdx

+49-63
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ import Contributors from '../../components/Contributors.astro';
3333

3434
:::section{.badges}
3535

36-
[![NPM Version](https://img.shields.io/npm/v/knip?color=f56e0f)](https://www.npmjs.com/package/knip)
37-
[![NPM Downloads](https://img.shields.io/npm/dm/knip?color=f56e0f)](https://www.npmjs.com/package/knip)
38-
[![GitHub Repo stars](https://img.shields.io/github/stars/webpro-nl/knip?style=flat&color=f56e0f)](https://github.com/webpro-nl/knip)
36+
[![NPM Version][2]][1] [![NPM Downloads][3]][1] [![GitHub Repo stars][5]][4]
3937

4038
:::
4139

@@ -47,44 +45,26 @@ import Contributors from '../../components/Contributors.astro';
4745

4846
:::div{.sponsor}
4947

50-
Using Knip? [You can support it!][2]
48+
Using Knip? [You can support it!][6]
5149

5250
:::
5351

5452
<CardGrid>
55-
<Card title="Why?" icon="approve-check">
53+
<Card title="Why use Knip?" icon="approve-check">
5654

5755
Knip finds and fixes unused files, dependencies and exports. Use it for
5856
enhanced code and dependency management.
5957

60-
Read the full explanation: [why should I use Knip?][1]
61-
6258
</Card>
6359

64-
<Card title="How?" icon="setting">
65-
66-
Deep analysis from fine-grained entry points based on the actual frameworks
67-
and tooling in (mono)repos for accurate and actionable results.
68-
Advanced features for maximum coverage:
60+
<Card title="How does it work?" icon="setting">
6961

70-
* Custom module resolution
71-
* Configuration file parsers
72-
* Advanced shell script parser
73-
* Built-in and custom compilers
74-
* Auto-fix most issues
62+
Advanced analysis starting from fine-grained entry points based on the
63+
actual frameworks and tooling in (mono)repos for accurate and actionable
64+
results.
7565

7666
</Card>
77-
</CardGrid>
7867

79-
## 🧡 Sponsors
80-
81-
Eternal gratitude to the companies and people that are already supporting Knip:
82-
83-
<Sponsors direction="row" showAll={false} />
84-
85-
Please see [Sponsors][2] for the full list. Consider supporting the project too!
86-
87-
<CardGrid stagger>
8868
<Card title="Battle-tested" icon="approve-check">
8969

9070
Thousands of projects are already using Knip!
@@ -93,34 +73,36 @@ Please see [Sponsors][2] for the full list. Consider supporting the project too!
9373

9474
<Card title="Plugins" icon="open-book">
9575

96-
Knip comes with [over 90 plugins][3] for tools and frameworks like Astro,
76+
Knip comes with [over 90 plugins][7] for tools and frameworks like Astro,
9777
Cypress, ESLint, Jest, GitHub Actions, Next.js, Nx, Remix, Storybook,
9878
Svelte, Vite, Vitest, Webpack and many many more.
9979

10080
</Card>
10181

10282
<Card title="Playground" icon="rocket">
10383

104-
Try Knip on the [playground][4].
84+
Try Knip on the [playground][8].
10585

10686
</Card>
10787

10888
<Card title="Troubleshooting" icon="warning">
10989

110-
Need help? [Start troubleshooting][5].
90+
Need help? [Start troubleshooting][9].
11191

11292
</Card>
93+
</CardGrid>
11394

114-
<Card title="/'knɪp/" icon="translate">
95+
## 🧡 Sponsors
11596

116-
Knip means "(to) cut" and is pronounced with a hard "K" 🇳🇱
97+
Eternal gratitude to the companies and people that are already supporting Knip:
11798

118-
</Card>
119-
</CardGrid>
99+
<Sponsors direction="row" showAll={false} />
100+
101+
Please see [Sponsors][6] for the full list. Consider supporting the project too!
120102

121103
## 🧡 Introduction video
122104

123-
[James Shopland][6] has a great introduction and overview of Knip (thanks
105+
[James Shopland][10] has a great introduction and overview of Knip (thanks
124106
James!):
125107

126108
<YouTube id="uhEkgWt-pUM" />
@@ -135,48 +117,52 @@ Special thanks to the wonderful people who have contributed to this project:
135117

136118
Most recent article first:
137119

138-
- Tom MacWright: [Knip: good software for cleaning up TypeScript tech debt][7]
120+
- Tom MacWright: [Knip: good software for cleaning up TypeScript tech debt][11]
139121
(2024-10-25)
140-
- [มาทำความสะอาด Project โค้ดของเราด้วย Knip กัน][8] (2024-10-22/Thai 🇹🇭)
141-
- Anthony Pena: [Knip: l'ultime outil pour faire le ménage dans vos projets!][9]
142-
(2024-10-08/French 🇫🇷)
143-
- Taro: [TypeScript/JavaScriptの不要なコードを削除するツール「Knip」の紹介][10]
122+
- [มาทำความสะอาด Project โค้ดของเราด้วย Knip กัน][12] (2024-10-22/Thai 🇹🇭)
123+
- Anthony Pena: [Knip: l'ultime outil pour faire le ménage dans vos
124+
projets!][13] (2024-10-08/French 🇫🇷)
125+
- Taro: [TypeScript/JavaScriptの不要なコードを削除するツール「Knip」の紹介][14]
144126
(2024-07-25/Japanese 🇯🇵)
145-
- Maddy Miller: [Using Knip to find dead code in a high-traffic git repo][11]
127+
- Maddy Miller: [Using Knip to find dead code in a high-traffic git repo][15]
146128
(2023-09-17)
147-
- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][12]
129+
- Josh Goldberg: [Speeding Up Centered Part 4: Unused Code Bloat][16]
148130
(2023-08-21)
149131
- Smashing Magazine: [Knip: An Automated Tool For Finding Unused Files, Exports,
150-
And Dependencies][13] (2023-08-14)
132+
And Dependencies][17] (2023-08-14)
151133
- Effective TypeScript: [Recommendation Update: ✂️ Use knip to detect dead code
152-
and types][14] (2023-07-29)
134+
and types][18] (2023-07-29)
153135

154136
## 🧡 Testimonials
155137

156138
<Posts />
157139

158140
## Read More
159141

160-
- [Unused dependencies][15]
161-
- [Unused exports][16]
162-
163-
[1]: ./explanations/why-use-knip.md
164-
[2]: ./sponsors
165-
[3]: ./reference/plugins.md
166-
[4]: ./playground
167-
[5]: ./guides/troubleshooting.md
168-
[6]: https://www.jamesshopland.com
169-
[7]: https://macwright.com/2024/10/25/good-software-knip
170-
[8]:
142+
- [Unused dependencies][19]
143+
- [Unused exports][20]
144+
145+
[1]: https://www.npmjs.com/package/knip
146+
[2]: https://img.shields.io/npm/v/knip?color=f56e0f
147+
[3]: https://img.shields.io/npm/dm/knip?color=f56e0f
148+
[4]: https://github.com/webpro-nl/knip
149+
[5]: https://img.shields.io/github/stars/webpro-nl/knip?style=flat&color=f56e0f
150+
[6]: ./sponsors
151+
[7]: ./reference/plugins.md
152+
[8]: ./playground
153+
[9]: ./guides/troubleshooting.md
154+
[10]: https://www.jamesshopland.com
155+
[11]: https://macwright.com/2024/10/25/good-software-knip
156+
[12]:
171157
https://engineering.thinknet.co.th/%E0%B8%A1%E0%B8%B2%E0%B8%97%E0%B8%B3%E0%B8%84%E0%B8%A7%E0%B8%B2%E0%B8%A1%E0%B8%AA%E0%B8%B0%E0%B8%AD%E0%B8%B2%E0%B8%94-project-%E0%B9%82%E0%B8%84%E0%B9%89%E0%B8%94%E0%B8%82%E0%B8%AD%E0%B8%87%E0%B9%80%E0%B8%A3%E0%B8%B2%E0%B8%94%E0%B9%89%E0%B8%A7%E0%B8%A2-knip-%E0%B8%81%E0%B8%B1%E0%B8%99-20dbd65f6b58
172-
[9]:
158+
[13]:
173159
https://k49.fr.nf/knip-l-ultime-outil-pour-faire-le-menage-dans-vos-projets/
174-
[10]: https://tech.basemachina.jp/entry/introduction-knip
175-
[11]: https://madelinemiller.dev/blog/knip-dead-code/
176-
[12]:
160+
[14]: https://tech.basemachina.jp/entry/introduction-knip
161+
[15]: https://madelinemiller.dev/blog/knip-dead-code/
162+
[16]:
177163
https://www.joshuakgoldberg.com/blog/speeding-up-centered-part-4-unused-code-bloat/
178-
[13]:
164+
[17]:
179165
https://www.smashingmagazine.com/2023/08/knip-automated-tool-find-unused-files-exports-dependencies/
180-
[14]: https://effectivetypescript.com/2023/07/29/knip/
181-
[15]: ./typescript/unused-dependencies.md
182-
[16]: ./typescript/unused-exports.md
166+
[18]: https://effectivetypescript.com/2023/07/29/knip/
167+
[19]: ./typescript/unused-dependencies.md
168+
[20]: ./typescript/unused-exports.md

‎packages/docs/src/pages/playground.astro

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
33
---
44

55
<StarlightPage frontmatter={{ title: 'Playground', template: 'splash' }}>
6-
<p>Welcome to the Knip playground. There are issues on purpose in the codebases below so Knip will report various types of issues.</p>
6+
<p>Welcome to the Knip playground. The codebases below have linting issues on purpose in the codebases, so Knip will report various types of issues.</p>
77

8-
<p>Feel free to play around!</p>
8+
<p>Feel free to play around! There are currently two playgrounds:</p>
99

1010
<ul>
1111
<li><a href="#basic">Basic</a></li>

0 commit comments

Comments
 (0)
Please sign in to comment.