Integracija z obstoječo temo
Ta tema je zasnovana tako, da brezhibno deluje z drugimi projekti Tailwind CSS v4.
Obvezni koraki
-
Kopirajte mapo
src/docsiz te teme v svoj obstoječi projekt.Večina elementov te teme se nahaja v mapi
src/docs. Prvi korak je torej ta, da celotno mapo preprosto kopirate v svoj obstoječi projekt (tako ohranite enako strukturo map na potisrc/docs). -
Uvozite sloge dokumentacije v svojo globalno datoteko css.
To storite tako, da v datoteko
global.cssza uvozom teme tailwind dodate naslednjo vrstico:src/styles/global.css /* theme definition import */@import "./tailwind-theme.css";/* docs styles */@import "@/docs/styles/docs-global.css"; -
Dodajte zbirko vsebine dokumentacije v konfiguracijsko datoteko zbirk vsebine svojega spletnega mesta.
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,}; -
Dodajte komponente mdx v integracijo 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",],}),],}); -
Dodajte strani dokumentacije na svoje spletno mesto.
Iz teme Tajo kopirajte celotno mapo
src/pages/docsv maposrc/pages/docssvojega spletnega mesta.
Neobvezni koraki
Pisave
Ta tema privzeto uporablja pisavo Inter. Priporočamo, da pisavo namestite lokalno prek storitve fontsource.
Nato v svojo datoteko fonts.css dodajte naslednje:
/* 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;}Druge pisave
Uporabite lahko tudi druge pisave. Poskrbite le, da potrebne pisave dodate v svojo datoteko fonts.css in posodobite lastnost font-family v datoteki src/docs/styles/docs-global.css.
Info
Pisavo naložite vnaprej tudi v komponenti src/docs/layouts/BaseHead.astro, podobno kot pisavo 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" />