From 9591960e31ffbaf9f86fc15acd841dd76009562a Mon Sep 17 00:00:00 2001 From: Valerio Ageno Date: Sun, 3 Nov 2024 22:07:22 +0100 Subject: [PATCH] feat: add canonical tags to documentation --- .../navigation-buttons/navigation-buttons.tsx | 82 +++++++++---------- .../src/routes/documentation/cli.mdx | 1 + .../src/routes/documentation/contributing.mdx | 1 + .../src/routes/documentation/index.mdx | 1 + .../src/routes/documentation/installation.mdx | 1 + .../routes/documentation/routing/index.mdx | 1 + .../routes/documentation/routing/intro.mdx | 1 + .../documentation/tutorial/api-fetching.mdx | 13 ++- .../documentation/tutorial/components.mdx | 13 ++- .../documentation/tutorial/conclusion.mdx | 11 ++- .../tutorial/development-setup.mdx | 10 ++- .../documentation/tutorial/dynamic-routes.mdx | 13 ++- .../documentation/tutorial/error-handling.mdx | 13 ++- .../routes/documentation/tutorial/index.mdx | 8 +- .../documentation/tutorial/production.mdx | 13 ++- .../documentation/tutorial/redirections.mdx | 13 ++- .../src/routes/documentation/tutorial/seo.mdx | 13 ++- apps/documentation/src/routes/index.tsx | 1 + 18 files changed, 140 insertions(+), 69 deletions(-) diff --git a/apps/documentation/src/components/navigation-buttons/navigation-buttons.tsx b/apps/documentation/src/components/navigation-buttons/navigation-buttons.tsx index 58dc8305..a7c2375c 100644 --- a/apps/documentation/src/components/navigation-buttons/navigation-buttons.tsx +++ b/apps/documentation/src/components/navigation-buttons/navigation-buttons.tsx @@ -3,60 +3,60 @@ import { Link } from 'tuono' import { IconArrowRight, IconArrowLeft } from '@tabler/icons-react' interface NavigationButton { - href: string - title: string + href: string + title: string } interface NavigationButtonsProps { - prev?: NavigationButton - next?: NavigationButton + prev?: NavigationButton + next?: NavigationButton } export default function NavigationButtons({ - prev, - next, + prev, + next, }: NavigationButtonsProps): JSX.Element { - return ( - - {prev && } - {next && } - - ) + return ( + + {prev && } + {next && } + + ) } interface NavigationButtonProps extends NavigationButton { - type: 'next' | 'prev' + type: 'next' | 'prev' } const NavigationBtn = ({ - type, - title, - href, + type, + title, + href, }: NavigationButtonProps): JSX.Element => { - const heading = type === 'next' ? 'Next' : 'Previous' - const textAlign = type === 'next' ? 'left' : 'right' - const variant = type === 'next' ? 'filled' : 'outline' + const heading = type === 'next' ? 'Next' : 'Previous' + const textAlign = type === 'next' ? 'left' : 'right' + const variant = type === 'next' ? 'filled' : 'outline' - return ( - - ) + return ( + + ) } diff --git a/apps/documentation/src/routes/documentation/cli.mdx b/apps/documentation/src/routes/documentation/cli.mdx index 155fd12a..540258e7 100644 --- a/apps/documentation/src/routes/documentation/cli.mdx +++ b/apps/documentation/src/routes/documentation/cli.mdx @@ -2,6 +2,7 @@ import { Head } from 'tuono' Tuono - CLI + import Breadcrumbs, { Element } from '../../components/breadcrumbs' diff --git a/apps/documentation/src/routes/documentation/contributing.mdx b/apps/documentation/src/routes/documentation/contributing.mdx index 2058af14..67189fd4 100644 --- a/apps/documentation/src/routes/documentation/contributing.mdx +++ b/apps/documentation/src/routes/documentation/contributing.mdx @@ -2,6 +2,7 @@ import { Head } from 'tuono' Tuono - Contributing + import Breadcrumbs, { Element } from '../../components/breadcrumbs' diff --git a/apps/documentation/src/routes/documentation/index.mdx b/apps/documentation/src/routes/documentation/index.mdx index 2b830df5..c71d7771 100644 --- a/apps/documentation/src/routes/documentation/index.mdx +++ b/apps/documentation/src/routes/documentation/index.mdx @@ -2,6 +2,7 @@ import { Head } from 'tuono' Tuono - Documentation + import Breadcrumbs from '../../components/breadcrumbs' diff --git a/apps/documentation/src/routes/documentation/installation.mdx b/apps/documentation/src/routes/documentation/installation.mdx index 7404dc45..28b1e2d2 100644 --- a/apps/documentation/src/routes/documentation/installation.mdx +++ b/apps/documentation/src/routes/documentation/installation.mdx @@ -3,6 +3,7 @@ import Breadcrumbs, { Element } from '../../components/breadcrumbs' Tuono - Installation + diff --git a/apps/documentation/src/routes/documentation/routing/index.mdx b/apps/documentation/src/routes/documentation/routing/index.mdx index 8761188d..99561e01 100644 --- a/apps/documentation/src/routes/documentation/routing/index.mdx +++ b/apps/documentation/src/routes/documentation/routing/index.mdx @@ -2,6 +2,7 @@ import { Head } from 'tuono' Tuono - Routing + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' diff --git a/apps/documentation/src/routes/documentation/routing/intro.mdx b/apps/documentation/src/routes/documentation/routing/intro.mdx index 7b830fc5..d1d7866b 100644 --- a/apps/documentation/src/routes/documentation/routing/intro.mdx +++ b/apps/documentation/src/routes/documentation/routing/intro.mdx @@ -2,6 +2,7 @@ import { Head } from 'tuono' Tuono - Routing + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' diff --git a/apps/documentation/src/routes/documentation/tutorial/api-fetching.mdx b/apps/documentation/src/routes/documentation/tutorial/api-fetching.mdx index 43c16dae..9b24ed61 100644 --- a/apps/documentation/src/routes/documentation/tutorial/api-fetching.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/api-fetching.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - API fetching + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -106,7 +110,10 @@ Refresh the browser now! A bit ugly, but all the Pokémon are finally printed on import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/components.mdx b/apps/documentation/src/routes/documentation/tutorial/components.mdx index d03b9bb8..6bfba001 100644 --- a/apps/documentation/src/routes/documentation/tutorial/components.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/components.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - Components + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -130,7 +134,10 @@ export default function PokemonLink({ import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/conclusion.mdx b/apps/documentation/src/routes/documentation/tutorial/conclusion.mdx index ba911400..a8e53ecb 100644 --- a/apps/documentation/src/routes/documentation/tutorial/conclusion.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/conclusion.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - Conclusion + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -25,6 +29,9 @@ Ciao import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/development-setup.mdx b/apps/documentation/src/routes/documentation/tutorial/development-setup.mdx index ec02b5a9..b51b590e 100644 --- a/apps/documentation/src/routes/documentation/tutorial/development-setup.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/development-setup.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - Development setup + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -67,7 +71,7 @@ Then open [http://localhost:3000/](http://localhost:3000) on the browser. import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/dynamic-routes.mdx b/apps/documentation/src/routes/documentation/tutorial/dynamic-routes.mdx index 9c6f7d4d..acf7a898 100644 --- a/apps/documentation/src/routes/documentation/tutorial/dynamic-routes.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/dynamic-routes.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - Dynamic routes + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -160,7 +164,10 @@ export default function PokemonView({ import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/error-handling.mdx b/apps/documentation/src/routes/documentation/tutorial/error-handling.mdx index c4a240a1..e02061ea 100644 --- a/apps/documentation/src/routes/documentation/tutorial/error-handling.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/error-handling.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - Error handling + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -103,7 +107,10 @@ correctly receive a 404 status code in the console. import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/index.mdx b/apps/documentation/src/routes/documentation/tutorial/index.mdx index 36268767..d083d60e 100644 --- a/apps/documentation/src/routes/documentation/tutorial/index.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/index.mdx @@ -2,6 +2,7 @@ import { Head } from 'tuono' Tuono - Tutorial + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -29,6 +30,9 @@ $ tuono new tutorial --template tutorial import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/production.mdx b/apps/documentation/src/routes/documentation/tutorial/production.mdx index fa6b12e7..7e1f0727 100644 --- a/apps/documentation/src/routes/documentation/tutorial/production.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/production.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - Building for production + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -34,7 +38,10 @@ optimizations ready to unleash the power of a rust server that seamlessly render import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/redirections.mdx b/apps/documentation/src/routes/documentation/tutorial/redirections.mdx index 2c6bbccc..4eb81a55 100644 --- a/apps/documentation/src/routes/documentation/tutorial/redirections.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/redirections.mdx @@ -2,6 +2,10 @@ import { Head } from 'tuono' Tutorial - Redirections + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -48,7 +52,10 @@ Click on it and see the application automatically redirecting you to your favour import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/documentation/tutorial/seo.mdx b/apps/documentation/src/routes/documentation/tutorial/seo.mdx index b4c4d2a4..2645f9a9 100644 --- a/apps/documentation/src/routes/documentation/tutorial/seo.mdx +++ b/apps/documentation/src/routes/documentation/tutorial/seo.mdx @@ -2,6 +2,7 @@ import { Head } from 'tuono' Tutorial - SEO and meta tags + import Breadcrumbs, { Element } from '../../../components/breadcrumbs' @@ -97,7 +98,13 @@ The `Head` component takes as children any valid HTML meta tag. import NavigationButtons from '../../../components/navigation-buttons' - diff --git a/apps/documentation/src/routes/index.tsx b/apps/documentation/src/routes/index.tsx index d598c527..04b13638 100644 --- a/apps/documentation/src/routes/index.tsx +++ b/apps/documentation/src/routes/index.tsx @@ -6,6 +6,7 @@ export default function IndexPage(): JSX.Element { <> Tuono - The React/Rust full-stack framework +