Integração com um tema existente
Este tema foi feito para funcionar sem atritos com outros projetos que usam Tailwind CSS v4.
Etapas obrigatórias
-
Copie a pasta
src/docsdeste tema para o seu projeto existente.A maior parte dos itens deste tema fica dentro da pasta
src/docs. Então o primeiro passo é simplesmente copiar essa pasta inteira para o seu projeto existente (mantendo a mesma estrutura de pastas emsrc/docs). -
Importe os estilos da documentação no seu arquivo css global.
Para isso, adicione a linha a seguir ao seu arquivo
global.css, depois da importação do tema do tailwind:src/styles/global.css /* theme definition import */@import "./tailwind-theme.css";/* docs styles */@import "@/docs/styles/docs-global.css"; -
Adicione a coleção de conteúdo da documentação ao arquivo de configuração de coleções de conteúdo do seu site.
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,}; -
Adicione os componentes mdx à integração 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",],}),],}); -
Adicione as páginas da documentação ao seu site.
A partir do tema Tajo, copie a pasta
src/pages/docsinteira para a pastasrc/pages/docsdo seu site.
Etapas opcionais
Fontes
Este tema usa a fonte Inter por padrão. Recomendamos instalar a fonte localmente pelo fontsource.
Depois, no seu arquivo fonts.css, adicione o seguinte:
/* 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;}Fontes alternativas
Você também pode usar outras fontes. Basta garantir que você adicionou as fontes necessárias ao seu arquivo fonts.css e que atualizou a propriedade font-family no seu arquivo src/docs/styles/docs-global.css.
Info
Você também deve pré-carregar a sua fonte no componente src/docs/layouts/BaseHead.astro, do mesmo jeito que a fonte 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" />