Update docs

webpro-nl · Sep 22, 2024 · d674020 · d674020
1 parent eb283cf
commit d674020
Show file tree

Hide file tree

Showing 9 changed files with 77 additions and 38 deletions.
diff --git a/packages/docs/src/content/docs/blog/knip-v3.mdx b/packages/docs/src/content/docs/blog/knip-v3.mdx
@@ -49,7 +49,7 @@ on your end:
 
 Try out the latest Knip v3 release today!
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell

diff --git a/packages/docs/src/content/docs/blog/knip-v4.mdx b/packages/docs/src/content/docs/blog/knip-v4.mdx
@@ -114,7 +114,7 @@ removed and option(s) added to the Knip configuration file. The docs are in the
 
 What are you waiting for? Start using Knip v4 today!
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell

diff --git a/packages/docs/src/content/docs/blog/knip-v5.mdx b/packages/docs/src/content/docs/blog/knip-v5.mdx
@@ -157,7 +157,7 @@ change is large enough to warrant a major bump.
 
 What are you waiting for? Start using Knip v5 today!
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell

diff --git a/packages/docs/src/content/docs/explanations/why-use-knip.md b/packages/docs/src/content/docs/explanations/why-use-knip.md
@@ -8,6 +8,18 @@ The value of removing clutter from your code is undeniable. However, finding
 them is a manual and tedious job. This is where Knip comes in. As codebases grow
 in complexity and size, automated and comprehensive tooling becomes critical.
 
+:::tip[TL;DR]
+
+Knip finds and fixes unused files, exports and dependencies.
+
+Deep analysis from [fine-grained entry points][1] based on the actual frameworks
+and tooling in your [(mono)repo][2] with [custom module resolution][6],
+[configuration file parsers][3], [compilers][4], a [shell script parser][5] and
+additional heuristics to maximize coverage for comprehensive and actionable
+results.
+
+:::
+
 ## Less is more
 
 There are plenty of reasons to delete unused files, dependencies and "dead
@@ -26,9 +38,9 @@ code":
   the same for files, dependencies and exports that you forgot to delete.
 - Keeping dead code around has a negative value on readability, as it can be
   misleading and distracting. Even if it serves no purpose it will need to be
-  maintained (source: [Safe dead code removal → YAGNI][1]).
-- Also see [Why are unused dependencies a problem?][2] and [Why are unused
-  exports a problem?][3].
+  maintained (source: [Safe dead code removal → YAGNI][7]).
+- Also see [Why are unused dependencies a problem?][8] and [Why are unused
+  exports a problem?][9].
 
 ## Automation
 
@@ -41,9 +53,10 @@ times better and faster than trying to do it manually.
 
 :::tip
 
-Knip not only finds clutter, it can also [clean it][4]! Use Knip next to a
-linter like ESLint or Biome: after removing unused variables inside files, Knip
-might find even more unused code. Rinse and repeat!
+Knip not only finds clutter, it can also [clean it][10]!
+
+Use Knip next to a linter like ESLint or Biome: after removing unused variables
+inside files, Knip might find even more unused code. Rinse and repeat!
 
 :::
 
@@ -55,9 +68,9 @@ synergy:
 
 - Utilizing plugins to find their dependencies includes the capacity to find
   additional entry files. This results in more resolved and used files. Better
-  coverage gives greater insights into unused files and exports.
-- Analyzing more files reveals more dependency usage, refining the list of both
-  unused and unlisted dependencies.
+  coverage gives better insights into unused files and exports.
+- Analyzing more files reveals more unused exports and dependency usage,
+  refining the list of both unused and unlisted dependencies.
 - This approach is amplified in a monorepo setting. In fact, files and internal
   dependencies can recursively reference each other (across workspaces).
 
@@ -94,13 +107,19 @@ so you can easily get rid of false positives? A variety of reasons:
 
 1. A false positive may be a bug in Knip, and should be reported (not easily
    dismissed).
-2. Instead of proprietary comments, use [standardized annotations][5] serving as
-   documentation as well.
+2. Instead of proprietary comments, use [standardized annotations][11] serving
+   as documentation as well.
 3. In the event you want to remove Knip, just uninstall `knip`. And not
    countless useless comments scattered throughout the codebase.
 
-[1]: https://jfmengels.net/safe-dead-code-removal/#yagni-you-arent-gonna-need-it
-[2]: ../typescript/unused-dependencies.md#why-are-unused-dependencies-a-problem
-[3]: ../typescript/unused-exports.md#why-are-unused-exports-a-problem
-[4]: ../features/auto-fix.mdx
-[5]: ../reference/jsdoc-tsdoc-tags.md
+[1]: ./entry-files.md
+[2]: ../features/monorepos-and-workspaces.md
+[3]: ./plugins.md#configuration-files
+[4]: ../features/compilers.md
+[5]: ../features/script-parser.md
+[6]: ../reference/faq.md#why-doesnt-knip-use-an-existing-module-resolver
+[7]: https://jfmengels.net/safe-dead-code-removal/#yagni-you-arent-gonna-need-it
+[8]: ../typescript/unused-dependencies.md#why-are-unused-dependencies-a-problem
+[9]: ../typescript/unused-exports.md#why-are-unused-exports-a-problem
+[10]: ../features/auto-fix.mdx
+[11]: ../reference/jsdoc-tsdoc-tags.md
diff --git a/packages/docs/src/content/docs/features/auto-fix.mdx b/packages/docs/src/content/docs/features/auto-fix.mdx
@@ -63,7 +63,7 @@ Rinse and repeat!
 Verify changes in `package.json` and update dependencies using your package
 manager:
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell

diff --git a/packages/docs/src/content/docs/index.mdx b/packages/docs/src/content/docs/index.mdx
@@ -1,12 +1,12 @@
 ---
-title: Knip the clutter!
+title: Declutter your JavaScript & TypeScript projects
 description:
   Project linter to find and remove unused files, dependencies and exports in
   JavaScript and TypeScript projects
 template: splash
 hero:
   title: Knip!
-  tagline: Cut the clutter from JavaScript & TypeScript projects
+  tagline: Declutter your JavaScript & TypeScript projects
   image:
     file: ../../assets/logo.svg
   actions:
@@ -27,28 +27,48 @@ import Sponsors from '../../components/Sponsors.astro';
 import Projects from '../../components/Projects.astro';
 import Contributors from '../../components/Contributors.astro';
 
+<CardGrid>
+  <Card title="Why?" icon="approve-check">
+
+    Knip finds and fixes unused files, exports and dependencies. Use it for enhanced
+    code and dependency management.
+
+    Read the full explanation: [why should I use Knip?][1]
+
+  </Card>
+
+  <Card title="How?" icon="setting">
+
+    Deep analysis from fine-grained entry points based on the actual frameworks
+    and tooling in your (mono)repo with custom module resolution, configuration
+    file parsers, compilers, a shell script parser and additional heuristics to
+    maximize coverage for comprehensive and actionable results.
+
+  </Card>
+</CardGrid>
+
 :::div{.sponsor}
 
-[Support Knip!][1]
+[Support Knip!][2]
 
 :::
 
 <CardGrid stagger>
-  <Card title="Why use Knip?" icon="approve-check">
+  <Card title="Battle-tested" icon="approve-check">
 
-    [Find & remove unused files, dependencies and exports][2]
+    Thousands of projects are already using Knip!
 
   </Card>
 
   <Card title="Playground" icon="rocket">
 
-    Try Knip on the [playground][3]
+    Try Knip on the [playground][3].
 
   </Card>
 
   <Card title="Troubleshooting" icon="warning">
 
-    Need help? [Start troubleshooting][4]
+    Need help? [Start troubleshooting][4].
 
   </Card>
 
@@ -80,7 +100,7 @@ Eternal gratitude to the companies and people that are already supporting Knip:
 
 <Sponsors direction="row" showAll={false} />
 
-Please see [Sponsors][1] for the full list. Consider supporting the project too!
+Please see [Sponsors][2] for the full list. Consider supporting the project too!
 
 ## 🧡 Contributors
 
@@ -108,8 +128,8 @@ Special thanks to the wonderful people who have contributed to this project:
 - [Unused dependencies][11]
 - [Unused exports][12]
 
-[1]: ./sponsors
-[2]: ./explanations/why-use-knip.md
+[1]: ./explanations/why-use-knip.md
+[2]: ./sponsors
 [3]: ./playground
 [4]: ./guides/troubleshooting.md
 [5]: https://www.jamesshopland.com

diff --git a/packages/docs/src/content/docs/overview/getting-started.mdx b/packages/docs/src/content/docs/overview/getting-started.mdx
@@ -16,7 +16,7 @@ Want to try Knip without installation? Visit [the playground][1].
 
 This is the easiest and recommended way to install Knip:
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell
@@ -52,7 +52,7 @@ This is the easiest and recommended way to install Knip:
 
 Now you can run Knip to lint your project:
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell
@@ -94,7 +94,7 @@ You can skip the rest of this page and go to [configuration][2].
 
 Alternatively, manually install Knip using your package manager:
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell
@@ -147,7 +147,7 @@ Then add a `knip` script to your `package.json`:
 
 To run Knip without adding it to your project:
 
-<Tabs>
+<Tabs syncKey="pm">
   <TabItem label="npm">
 
     ```shell

diff --git a/packages/docs/src/content/docs/reference/dynamic-configuration.mdx b/packages/docs/src/content/docs/reference/dynamic-configuration.mdx
@@ -9,7 +9,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
 Instead of a JSON file, you can use a JavaScript or TypeScript file for a
 dynamic configuration and type annotations:
 
-<Tabs>
+<Tabs syncKey="lang">
   <TabItem label="TypeScript">
 
     ```ts title="knip.ts"
@@ -45,7 +45,7 @@ dynamic configuration and type annotations:
 You can export a regular or async function that returns the configuration object
 as well:
 
-<Tabs>
+<Tabs syncKey="lang">
   <TabItem label="TypeScript">
 
     ```ts title="knip.ts"

diff --git a/packages/docs/src/styles/content.css b/packages/docs/src/styles/content.css
@@ -91,10 +91,10 @@ section.plugins li {
   }
 }
 
-.sponsor {
+.sl-markdown-content .sponsor {
   font-size: 2rem;
   text-align: center;
-  margin-bottom: 5rem;
+  margin: 5rem 0;
 }
 
 .sl-badge.caution,