Перейти к содержимому
Starlight

CSS и стилизация

Вы можете стилизовать ваш сайт Starlight с помощью CSS-файлов или использовать плагин Starlight Tailwind.

Ваши CSS стили

Настройте стили, применяемые к вашему сайту Starlight, предоставив дополнительные CSS-файлы для изменения или расширения стандартных стилей Starlight.

  1. Добавьте CSS-файл в ваш каталог src/. Например, вы можете установить большую ширину колонки по умолчанию и бóльший размер текста для заголовков страниц:

    src/styles/custom.css
    :root {
      --sl-content-width: 50rem;
      --sl-text-5xl: 3.5rem;
    }

  2. Добавьте путь к вашему CSS-файлу в массив customCss Starlight в astro.config.mjs:

    astro.config.mjs
    import { defineConfig } from 'astro/config';
    import starlight from '@astrojs/starlight';
    

    export default defineConfig({
      integrations: [
        starlight({
          title: 'Документация с изменёнными CSS-стилями',
          customCss: [
            // Относительный путь к вашему CSS файлу
            './src/styles/custom.css',
          ],
        }),
      ],
    });

Вы можете увидеть все кастомные свойства CSS, используемые Starlight, которые вы можете установить для настройки вашего сайта, в файле props.css на GitHub.

Tailwind CSS

Поддержка Tailwind CSS в проектах Astro предоставляется интеграцией Astro Tailwind. Starlight предоставляет дополнительный плагин Tailwind для совместимости со стилями Starlight.

Плагин Tailwind для Starlight применяет следующую конфигурацию:

  • Настраивает dark: варианты Tailwind для работы с тёмным режимом Starlight.
  • Использует цвета и шрифты темы Tailwind в пользовательском интерфейсе Starlight.
  • Отключает стили сброса Preflight Tailwind при выборочном восстановлении основных частей Preflight, необходимых для служебных border-классов Tailwind.

Создание нового проекта с Tailwind

Создайте новый проект Starlight с предварительно настроенным Tailwind CSS, используя create astro:

Окно терминала
npm create astro@latest -- --template starlight/tailwind

Добавление Tailwind в существующий проект

Если у вас уже есть сайт на Starlight и вы хотите добавить Tailwind CSS, следуйте этим шагам.

  1. Добавьте интеграцию Tailwind от Astro:

    Окно терминала
    npx astro add tailwind

  2. Установите плагин Tailwind для Starlight:

    Окно терминала
    npm install @astrojs/starlight-tailwind

  3. Создайте CSS-файл для базовых стилей Tailwind, например, в src/tailwind.css:

    src/tailwind.css
    @tailwind base;
    @tailwind components;
    @tailwind utilities;

  4. Обновите ваш конфигурационный файл Astro, чтобы использовать ваши базовые стили Tailwind и отключить базовые стили по умолчанию:

    astro.config.mjs
    import { defineConfig } from 'astro/config';
    import starlight from '@astrojs/starlight';
    import tailwind from '@astrojs/tailwind';
    

    export default defineConfig({
      integrations: [
        starlight({
          title: 'Docs with Tailwind',
          customCss: [
            // Путь к базовым стилям Tailwind:
            './src/tailwind.css',
          ],
        }),
        tailwind({
          // Отключите базовые стили:
          applyBaseStyles: false,
        }),
      ],
    });

  5. Добавьте плагин Starlight Tailwind в tailwind.config.mjs:

    tailwind.config.mjs
    import starlightPlugin from '@astrojs/starlight-tailwind';
    

    /** @type {import('tailwindcss').Config} */
    module.exports = {
      content: ['./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}'],
      plugins: [starlightPlugin()],
    };

Стилизация Starlight с использованием Tailwind

Starlight будет использовать значения из вашей конфигурации темы Tailwind в своем интерфейсе.

Если установлены, следующие параметры переопределят стили Starlight по умолчанию:

  • colors.accent — используется для ссылок и выделения текущего элемента;
  • colors.gray — используется для цветов фона и границ;
  • fontFamily.sans — используется для текста в интерфейсе и контента;
  • fontFamily.mono — используется для примеров кода.
tailwind.config.mjs
import starlightPlugin from '@astrojs/starlight-tailwind';
import colors from 'tailwindcss/colors';


/** @type {import('tailwindcss').Config} */
module.exports = {
  content: ['./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}'],
  theme: {
    extend: {
      colors: {
        // Ваш предпочтительный акцентный цвет. Indigo наиболее близок к стандартным настройкам Starlight.
        accent: colors.indigo,
        // Ваш предпочтительный оттенок серого. Zinc наиболее близок к стандартным настройкам Starlight.
        gray: colors.zinc,
      },
      fontFamily: {
        // Ваш предпочтительный шрифт для текста. По умолчанию Starlight использует системные шрифты.
        sans: ['"Atkinson Hyperlegible"'],
        // Ваш предпочтительный шрифт для кода. По умолчанию Starlight использует системные моноширинные шрифты.
        mono: ['"IBM Plex Mono"'],
      },
    },
  },
  plugins: [starlightPlugin()],
};

Темизация

Цветовая тема Starlight может быть настроена путем переопределения её стандартных кастомных свойств. Эти переменные используются по всему интерфейсу, причём различные оттенки серого используются для текста и цветов фона, а акцентный цвет используется для ссылок и выделения текущих элементов в навигации.

Редактор цветовой темы

Используйте ползунки ниже, чтобы изменить палитры акцентного и серого цветов Starlight. Темные и светлые области предпросмотра будут показывать результирующие цвета, и вся страница также обновится, чтобы показать ваши изменения.

Когда вы будете довольны внесёнными изменениями, скопируйте приведённый ниже код CSS или Tailwind и используйте его в своем проекте.

Заготовки
Акцентный цвет
Серый

Тёмный режим

Основной текст отображается в оттенке серого с высоким контрастом по отношению к фону. Ссылки выделены цветом. Некоторый текст, например, оглавление, имеет меньший контраст. Встроенный код имеет выделенный фон.

Светлый режим

Основной текст отображается в оттенке серого с высоким контрастом по отношению к фону. Ссылки выделены цветом. Некоторый текст, например, оглавление, имеет меньший контраст. Встроенный код имеет выделенный фон.

Добавьте следующий CSS в ваш проект в пользовательском CSS-файле, чтобы применить эту тему к вашему сайту.