Быстрый старт

Этот плагин предоставляет блок комментариев Giscus для вашего сайта документации.

Предварительные требования

Вам необходимо настроить сайт Starlight. Если вы ещё не создали его, вы можете обратиться к руководству Первые шаги в документации Starlight, чтобы его настроить.

Установка

1. starlight-giscus — это плагин для Starlight. Установите его, выполнив следующую команду в вашем терминале:

   npm

   npm i starlight-giscus

   pnpm

   pnpm add starlight-giscus

   yarn

   yarn add starlight-giscus

2. Настройте приложение Giscus.

3. Настройте плагин в вашей конфигурации Starlight в файле astro.config.mjs.

   astro.config.mjs

   import starlight from '@astrojs/starlight'
   import { defineConfig } from 'astro/config'
   import starlightGiscus from 'starlight-giscus'
   
   export default defineConfig({
     integrations: [
       starlight({
        plugins: [
          starlightGiscus({
              repo: 'username/github_repo_name',
              repoId: 'repository_id_from_giscus',
              category: 'category_name_from_github_discussions',
              categoryId: 'category_id_from_giscus'
          })
        ],
         title: 'My Docs',
       }),
     ],
   })

4. (Необязательно) Если вы уже переопределяете или хотите переопределить стандартный компонент Pagination, добавьте Comments.astro в свой код:

   CustomPagination.astro

   ---
   import Comments from 'starlight-giscus/components/Comments.astro';
   import OriginalPagination from '@astrojs/starlight/components/Pagination.astro';
   ---
   
   <Comments />
   
   Вставьте ваш вариант кода пагинации
   
   или используйте стандартный компонент: <OriginalPagination />

5. Запустите сервер разработки, чтобы проверить плагин в работе.