From 76e06aa8838a6b978e34e5fafa8ad0788d8553af Mon Sep 17 00:00:00 2001 From: Dany Castillo <31006608+dcastil@users.noreply.github.com> Date: Sat, 13 Aug 2022 23:50:06 +0200 Subject: [PATCH] add navigation links to doc pages --- docs/api-reference.md | 6 ++++++ docs/configuring-tailwind-merge.md | 6 ++++++ docs/features.md | 6 ++++++ docs/similar-packages.md | 6 ++++++ docs/versioning.md | 6 ++++++ docs/what-is-it-for.md | 6 ++++++ docs/writing-plugins.md | 6 ++++++ 7 files changed, 42 insertions(+) diff --git a/docs/api-reference.md b/docs/api-reference.md index 4a97c228..086b516e 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -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) diff --git a/docs/configuring-tailwind-merge.md b/docs/configuring-tailwind-merge.md index b0a51188..cd14b791 100644 --- a/docs/configuring-tailwind-merge.md +++ b/docs/configuring-tailwind-merge.md @@ -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) diff --git a/docs/features.md b/docs/features.md index 99a65c15..5d8a33ec 100644 --- a/docs/features.md +++ b/docs/features.md @@ -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) diff --git a/docs/similar-packages.md b/docs/similar-packages.md index 3185b142..671a3e8f 100644 --- a/docs/similar-packages.md +++ b/docs/similar-packages.md @@ -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) diff --git a/docs/versioning.md b/docs/versioning.md index fdcfe94a..ada69b89 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -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.`. - 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) diff --git a/docs/what-is-it-for.md b/docs/what-is-it-for.md index f19788c4..53fd29b5 100644 --- a/docs/what-is-it-for.md +++ b/docs/what-is-it-for.md @@ -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) diff --git a/docs/writing-plugins.md b/docs/writing-plugins.md index 040d04a8..38ac7882 100644 --- a/docs/writing-plugins.md +++ b/docs/writing-plugins.md @@ -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)