Skip to content

Commit

Permalink
add navigation links to doc pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dcastil committed Aug 13, 2022
1 parent 69f4742 commit 76e06aa
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,3 +234,9 @@ interface Config { … }
```

TypeScript type for config object. Useful if you want to build a `createConfig` function but don't want to define it inline in [`extendTailwindMerge`](#extendtailwindmerge) or [`createTailwindMerge`](#createtailwindmerge).

---

Next: [Writing plugins](./writing-plugins.md)

Previous: [Configuring tailwind-merge](./configuring-tailwind-merge.md)
6 changes: 6 additions & 0 deletions docs/configuring-tailwind-merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,9 @@ const twMerge2 = extendTailwindMerge(withMagic, withMoreMagic)
// Using `createTailwindMerge`
const twMerge3 = createTailwindMerge(() => ({ … }), withMagic, withMoreMagic)
```

---

Next: [API reference](./api-reference.md)

Previous: [Features](./features.md)
6 changes: 6 additions & 0 deletions docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,9 @@ twMerge('some-class', undefined, null, false, 0) // → 'some-class'
twMerge('some-class', [undefined, ['another-class', false]], ['third-class'])
// → 'some-class another-class third-class'
```

---

Next: [Configuring tailwind-merge](./configuring-tailwind-merge.md)

Previous: [What is it for](./what-is-it-for.md)
6 changes: 6 additions & 0 deletions docs/similar-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,9 @@
- [tailshake](https://www.npmjs.com/package/tailshake)
- [tailwind-classlist](https://www.npmjs.com/package/tailwind-classlist)
- [tailwind-override](https://www.npmjs.com/package/tailwind-override)

---

Next: [Contributing](../.github/CONTRIBUTING.md)

Previous: [Versioning](./versioning.md)
6 changes: 6 additions & 0 deletions docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@ This package follows the [SemVer](https://semver.org) versioning rules. More spe
- A non-production-ready version of every commit pushed to the main branch is released under the `dev` tag for testing purposes. It has the format `0.0.0-dev.<git SHA>`.

- A changelog is documented in [GitHub Releases](https://github.com/dcastil/tailwind-merge/releases).

---

Next: [Similar packages](./similar-packages.md)

Previous: [Writing plugins](./writing-plugins.md)
6 changes: 6 additions & 0 deletions docs/what-is-it-for.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@ function MyGenericInput(props) {
```

tailwind-merge overrides conflicting classes and keeps everything else untouched. In the case of the `MySlightlyModifiedInput`, the input now only renders the classes `border rounded p-3`.

---

Next: [Features](./features.md)

Previous: [Overview](../README.md)
6 changes: 6 additions & 0 deletions docs/writing-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,9 @@ const twMerge = extendTailwindMerge(withMagic)
```

Also, feel free to check out [tailwind-merge-rtl-plugin](https://www.npmjs.com/package/tailwind-merge-rtl-plugin) as a real example of a tailwind-merge plugin.

---

Next: [Versioning](./versioning.md)

Previous: [API reference](./api-reference.md)

0 comments on commit 76e06aa

Please sign in to comment.