Подайте заявку на ранний доступ

Укажите имя, а также email или номер телефона. Мы отправим Вам информацию о доступе к Tajo.

Интеграция с существующей темой

Эта тема рассчитана на бесшовную работу с другими проектами на Tailwind CSS v4.

Обязательные шаги

  1. Скопируйте папку src/docs из этой темы в свой проект.

    Большая часть содержимого темы находится в папке src/docs. Поэтому первый шаг: просто скопировать всю эту папку в свой проект (сохранив ту же структуру каталогов по пути src/docs).

  2. Подключите стили документации в свой глобальный css-файл.

    Для этого добавьте следующую строку в файл global.css после импорта темы tailwind:

    src/styles/global.css
    /* theme definition import */
    @import "./tailwind-theme.css";
    /* docs styles */
    @import "@/docs/styles/docs-global.css";
  3. Добавьте коллекцию контента docs в файл конфигурации коллекций контента вашего сайта.

    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. Добавьте mdx-компоненты в интеграцию 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. Добавьте страницы документации на свой сайт.

    Скопируйте из темы Tajo всю папку src/pages/docs в папку src/pages/docs вашего сайта.

Необязательные шаги

Шрифты

По умолчанию эта тема использует шрифт Inter. Рекомендуется установить шрифт локально из fontsource.

Затем добавьте в файл fonts.css следующее:

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

Альтернативные шрифты

Можно использовать и другие шрифты. Просто убедитесь, что нужные шрифты добавлены в файл fonts.css, и обновите свойство font-family в файле src/docs/styles/docs-global.css.

Info

Также следует предварительно загрузить шрифт в компоненте src/docs/layouts/BaseHead.astro, как это сделано для шрифта 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" />

Подайте заявку на ранний доступ

Укажите имя, а также email или номер телефона. Мы отправим Вам информацию о доступе к Tajo.

определим автоматически
AI-ассистент

Привет! Спрашивайте меня о документации.