jacob-mathison/tuono
1
0
Fork 0
mirror of https://github.com/tuono-labs/tuono synced 2026-07-25 21:02:45 -07:00
Code Issues Packages Projects Releases Wiki Activity

feat: add breadcrumbs to documentation

Browse Source
This commit is contained in:
Valerio Ageno
2024-08-15 18:52:56 +02:00
parent a7b7f0eac2
commit b2940d9fa8
7 changed files with 83 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/documentation/src/components/breadcrumbs/breadcrumbs.tsx
+46
View File
@@ -0,0 +1,46 @@
import { Breadcrumbs, Button } from '@mantine/core'
import { Link } from 'tuono'
import { IconChevronRight, IconBolt } from '@tabler/icons-react'
import type { ReactNode } from 'react'
export default function TuonoBreadcrumbs({
children,
}: {
children: ReactNode
}): JSX.Element {
return (
<Breadcrumbs
separator={<IconChevronRight size="1.1rem" stroke={1.5} />}
mb="md"
mt="md"
>
<Button href="/" component={Link} variant="subtle" radius="xl" p={5}>
<IconBolt />
</Button>
{children}
</Breadcrumbs>
)
}
interface BreadcrumbElementProps {
href?: string
label: string
}
export function BreadcrumbElement({
href,
label,
}: BreadcrumbElementProps): JSX.Element {
return (
<Button
component={href ? Link : 'span'}
href={href}
variant={href ? 'subtle' : 'light'}
radius="xl"
px={href ? 10 : undefined}
>
{label}
</Button>
)
}
apps/documentation/src/components/breadcrumbs/index.ts
+5
View File
@@ -0,0 +1,5 @@
import Breadcrumbs, { BreadcrumbElement } from './breadcrumbs'
export default Breadcrumbs
export { BreadcrumbElement as Element }
apps/documentation/src/routes/documentation/contributing.mdx
+6
View File
@@ -4,6 +4,12 @@ import { Head } from 'tuono'
<title>Tuono - Contributing</title>
</Head>
import Breadcrumbs, { Element } from '../../components/breadcrumbs'
<Breadcrumbs>
<Element label="Contributing"/>
</Breadcrumbs>
# How to contribute
## TL;DR
apps/documentation/src/routes/documentation/installation.mdx
+5
View File
@@ -1,9 +1,14 @@
import { Head } from 'tuono'
import Breadcrumbs, { Element } from '../../components/breadcrumbs'
<Head>
<title>Tuono - Installation</title>
</Head>
<Breadcrumbs>
<Element label="Installation"/>
</Breadcrumbs>
# Installation
## Requirements
apps/documentation/src/routes/documentation/routing/index.mdx
+8
View File
@@ -4,4 +4,12 @@ import { Head } from 'tuono'
<title>Tuono - Routing</title>
</Head>
import Breadcrumbs, { Element } from '../../../components/breadcrumbs'
<Breadcrumbs>
<Element label="Routing"/>
</Breadcrumbs>
# Routing index
TODO
apps/documentation/src/routes/documentation/routing/intro.mdx
+7
View File
@@ -4,6 +4,13 @@ import { Head } from 'tuono'
<title>Tuono - Routing</title>
</Head>
import Breadcrumbs, { Element } from '../../../components/breadcrumbs'
<Breadcrumbs>
<Element label="Routing" href="/documentation/routing"/>
<Element label="Project structure"/>
</Breadcrumbs>
# Project structure
Todo
apps/documentation/src/routes/documentation/tutorial/intro.mdx
+6
View File
@@ -4,6 +4,12 @@ import { Head } from 'tuono'
<title>Tuono - Tutorial intro</title>
</Head>
import Breadcrumbs, { Element } from '../../../components/breadcrumbs'
<Breadcrumbs>
<Element label="Tutorial"/>
</Breadcrumbs>
# Tutorial intro
TODO