Poproś o wcześniejszy dostęp

Podaj imię oraz adres e-mail lub numer telefonu. Wyślemy Ci informacje o dostępie do Tajo.

Integracja z istniejącym motywem

Ten motyw został zaprojektowany tak, aby działał bezproblemowo z innymi projektami opartymi na Tailwind CSS v4.

Wymagane kroki

  1. Skopiuj folder src/docs z tego motywu do swojego istniejącego projektu.

    Większość elementów tego motywu znajduje się w folderze src/docs. Pierwszym krokiem jest więc po prostu skopiowanie całego tego folderu do Twojego projektu (zachowaj tę samą strukturę folderów w src/docs).

  2. Zaimportuj style dokumentacji do swojego globalnego pliku css.

    Możesz to zrobić, dodając poniższą linię do pliku global.css po imporcie motywu Tailwind:

    src/styles/global.css
    /* theme definition import */
    @import "./tailwind-theme.css";
    /* docs styles */
    @import "@/docs/styles/docs-global.css";
  3. Dodaj kolekcję treści dokumentacji do pliku konfiguracyjnego kolekcji treści Twojej witryny.

    src/content.config.ts
    // other collections...
    const docsCollection = defineCollection({
    loader: glob({ pattern: "**/[^_]*{md,mdx}", base: "./src/docs/data/docs" }),
    schema: () =>
    z.object({
    title: z.string(),
    description: z.string().optional(),
    sidebar: z
    .object({
    label: z.string().optional(),
    order: z.number().optional(),
    badge: z
    .object({
    text: z.string(),
    variant: z.enum(["note", "tip", "caution", "danger", "info"]).default("note"),
    })
    .optional(),
    })
    .optional(),
    tableOfContents: z
    .object({
    minHeadingLevel: z.number().min(1).max(6).optional(),
    maxHeadingLevel: z.number().min(1).max(6).optional(),
    })
    .optional(),
    pagefind: z.boolean().optional(),
    mappingKey: z.string().optional(),
    draft: z.boolean().optional(),
    }),
    });
    export const collections = {
    // other collection....
    docs: docsCollection,
    };
  4. Dodaj komponenty mdx do integracji AutoImport

    astro.config.mjs
    export default defineConfig({
    // other config options...
    integrations: [
    AutoImport({
    imports: [
    // other imports...
    "@/docs/components/mdx-components/Aside.astro",
    "@/docs/components/mdx-components/Badge.astro",
    "@/docs/components/mdx-components/Button.astro",
    "@/docs/components/mdx-components/Steps.astro",
    "@/docs/components/mdx-components/Tabs.astro",
    "@/docs/components/mdx-components/TabsContent.astro",
    "@/docs/components/mdx-components/TabsList.astro",
    "@/docs/components/mdx-components/TabsTrigger.astro",
    ],
    }),
    ],
    });
  5. Dodaj strony dokumentacji do swojej witryny.

    Z motywu Tajo skopiuj cały folder src/pages/docs do folderu src/pages/docs w swojej witrynie.

Kroki opcjonalne

Czcionki

Ten motyw domyślnie używa czcionki Inter. Zalecamy zainstalowanie jej lokalnie z fontsource.

Następnie w pliku fonts.css dodaj poniższy fragment:

src/styles/fonts.css
/* inter-latin-wght-normal */
@font-face {
font-family: "Inter Variable";
font-style: normal;
font-display: swap;
font-weight: 100 900;
src: url(@fontsource-variable/inter/files/inter-latin-wght-normal.woff2)
format("woff2-variations");
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304,
U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF,
U+FFFD;
}

Alternatywne czcionki

Możesz też użyć innych czcionek. Zadbaj tylko o to, aby dodać potrzebne czcionki do pliku fonts.css i zaktualizować właściwość font-family w pliku src/docs/styles/docs-global.css.

Info

Warto również wstępnie załadować swoją czcionkę w komponencie src/docs/layouts/BaseHead.astro, podobnie jak czcionkę Inter.

---
import InterVariable from "@fontsource-variable/inter/files/inter-latin-wght-normal.woff2";
---
<link rel="preload" href={InterVariable} as="font" type="font/woff2" crossorigin="anonymous" />

Poproś o wcześniejszy dostęp

Podaj imię oraz adres e-mail lub numer telefonu. Wyślemy Ci informacje o dostępie do Tajo.

rozpoznajemy automatycznie
Asystent AI

Cześć! Zapytaj mnie o dokumentację.