Požádejte o přednostní přístup

Uveďte své křestní jméno a e-mail nebo telefonní číslo. Pošleme Vám informace o přístupu k platformě Tajo.

Na této stránce

Integrace do existující šablony

Tato šablona je navržena tak, aby bez potíží fungovala s dalšími projekty postavenými na Tailwind CSS v4.

Povinné kroky

Zkopírujte složku src/docs z této šablony do svého existujícího projektu.

Většina prvků této šablony se nachází ve složce src/docs. Prvním krokem je tedy jednoduše zkopírovat celou tuto složku do Vašeho existujícího projektu (zachovejte stejnou strukturu složek v src/docs).
Naimportujte styly dokumentace do svého globálního souboru CSS.

Provedete to přidáním následujícího řádku do souboru global.css za import tématu Tailwind:
src/styles/global.css
```
/* theme definition import */
@import "./tailwind-theme.css";

/* docs styles */
@import "@/docs/styles/docs-global.css";
```

Přidejte kolekci obsahu docs do konfiguračního souboru kolekcí obsahu svého webu.

// 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,
};

Přidejte mdx komponenty do integrace AutoImport

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",
      ],
    }),
  ],
});

Přidejte stránky dokumentace na svůj web.

Ze šablony Tajo zkopírujte celou složku src/pages/docs do složky src/pages/docs svého webu.

Volitelné kroky

Písma

Tato šablona ve výchozím nastavení používá písmo Inter. Doporučujeme nainstalovat písmo lokálně ze fontsource.

Poté do svého souboru fonts.css přidejte následující:

/* 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;
}

Alternativní písma

Můžete použít i jiná písma. Jen se ujistěte, že potřebná písma přidáte do souboru fonts.css a upravíte vlastnost font-family v souboru src/docs/styles/docs-global.css.

Info

Své písmo byste také měli přednačíst v komponentě src/docs/layouts/BaseHead.astro, podobně jako písmo 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" />