astro.config.ts

import process from 'node:process'
import sentry from '@sentry/astro'
import tailwind from '@astrojs/tailwind'
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import spotlightjs from '@spotlightjs/astro'
import starlightLinksValidator from 'starlight-links-validator'

const SITE_URL = 'https://docs.ethfollow.xyz/'

// https://astro.build/config
export default defineConfig({
  site: SITE_URL,
  prefetch: true,
  output: 'static',
  trailingSlash: 'ignore',
  integrations: [
    sentry(),
    spotlightjs(),
    tailwind({ applyBaseStyles: false, configFile: 'tailwind.config.ts' }),
    starlight({
      title: 'EFP Docs',
      tagline: 'Ethereum Follow Protocol',
      description: 'Ethereum Follow Protocol technical documentation',
      favicon: '/favicon.ico',
      lastUpdated: true,
      expressiveCode: {
        frames: {
          showCopyToClipboardButton: true
        },
        useStarlightDarkModeSwitch: true,
        useStarlightUiThemeColors: true
      },
      social: {
        github: 'https://github.com/ethereumfollowprotocol',
        discord: 'https://discord.ethfollow.xyz',
        'x.com': 'https://x.com/efp'
      },
      locales: {
        root: {
          label: 'English',
          lang: 'en'
        }
      },
      defaultLocale: 'en',
      logo: {
        src: './src/assets/logo.png',
        alt: 'Ethereum Follow Protocol Logo'
      },
      editLink: {
        baseUrl: 'https://github.com/ethereumfollowprotocol/docs/tree/main'
      },
      tableOfContents: {
        maxHeadingLevel: 4
      },
      sidebar: [
        {
          label: 'Introduction',
          link: '/intro'
        },
        {
          label: 'Specification',
          collapsed: false,
          items: [
            {
              label: 'List Registry',
              link: '/design/list-registry'
            },
            {
              label: 'Roles',
              link: '/design/roles'
            },
            {
              label: 'Account Metadata',
              link: '/design/account-metadata'
            },
            {
              label: 'List Metadata',
              link: '/design/list-metadata'
            },
            {
              label: 'List Storage Location',
              link: '/design/list-storage-location'
            },
            {
              label: 'List Records',
              link: '/design/list-records'
            },
            {
              label: 'Tags',
              link: '/design/tags'
            },
            {
              label: 'List Ops',
              link: '/design/list-ops'
            },
            {
                label: 'Interpreting EFP Data',
                link: '/design/interpreting-state'
              },
            {
              label: 'EFP Multisig',
              link: '/design/multisig'
            },
            {
              label: 'Deployments',
              link: '/design/deployments'
            },
            {
                label: 'Backend Architecture',
                link: '/design/backend'
            },
            {
              label: 'Glossary',
              link: '/design/glossary'
            }
          ]
        },
        {
          label: 'Public API',
          collapsed: false,
          items: [
            {
                label: 'Introduction',
                link: '/api'
            },
            {
                label: 'Discover',
                link: '/api/discover'
            },
            {
                label: 'Export State',
                link: '/api/exportstate'
            },
            {
                label: 'Leaderboard',
                collapsed: true,
                autogenerate: {
                    directory: 'api/Leaderboard'
                },
            },
            {
                label: 'Lists',
                collapsed: true,
                autogenerate: {
                    directory: 'api/Lists'
                },
            },
            {
                label: 'Stats',
                link: '/api/stats'
            },
            {
                label: 'Token',
                collapsed: true,
                autogenerate: {
                    directory: 'api/Token'
                },
            },
            {
                label: 'Users',
                collapsed: true,
                autogenerate: {
                    directory: 'api/Users'
                },
            },
          ],
          
          badge: {
            text: '/api/v1',
            variant: 'tip'
          }
        },
        {
          label: 'Design Components',
          collapsed: false,
          items: [
            {
              label: 'Colors',
              link: '/design-components/colors'
            },
            {
              label: 'Logos',
              link: '/design-components/logos'
            }
          ]
        },
        {
          label: 'FAQ',
          link: '/faq'
        },
        {
          label: 'Forum',
          link: 'https://forum.ethfollow.xyz/'
        },
        {
          label: 'Discord',
          link: 'https://discord.com/invite/ZUyG3mSXFD'
        },
        {
          label: 'Dune Analytics',
          link: 'https://dune.com/throw_efp/efp'
        },
        {
          label: 'Translation Bounty',
          link: '/translationbounty'
        },
        {
          label: 'Bug Bounty',
          link: '/bugbounty'
        }
        // {
        //   label: 'Airdrop',
        //   link: '/bugbounty'
        // }
      ],
      head: [
        {
          tag: 'link',
          attrs: {
            rel: 'icon',
            href: '/favicon.ico'
          }
        },
        {
          tag: 'meta',
          attrs: {
            name: 'og:image',
            property: 'og:image',
            content: `${SITE_URL}/og.png`
          }
        },
        {
          tag: 'meta',
          attrs: {
            name: 'twitter:image',
            property: 'twitter:image',
            content: `${SITE_URL}/og.png`
          }
        },
        {
          tag: 'meta',
          attrs: {
            name: 'twitter:card',
            property: 'twitter:card',
            content: 'summary_large_image'
          }
        },
        {
          tag: 'meta',
          attrs: {
            name: 'twitter:description',
            property: 'twitter:description',
            content: 'The social graph for Ethereum.'
          }
        },
        {
          tag: 'meta',
          attrs: {
            name: 'twitter:domain',
            property: 'twitter:domain',
            content: 'ethfollow.xyz'
          }
        },
        {
          tag: 'meta',
          attrs: {
            name: 'twitter:url',
            property: 'twitter:url',
            content: 'https://ethfollow.xyz'
          }
        },
        {
          tag: 'meta',
          attrs: {
            name: 'twitter:title',
            property: 'twitter:title',
            content: 'Ethereum Follow Protocol - Documentation'
          }
        },
        {
          tag: 'script',
          attrs: {
            type: 'module',
            src: '/anchor-targets.js'
          }
        },
        {
          tag: 'script',
          attrs: {
            src: import.meta.env.PROD ? 'https://static.cloudflareinsights.com/beacon.min.js' : '',
            'data-cf-beacon': '{"token": "bb866b6c87ba4c5ca9eb7fd636a5e2cf"}',
            defer: true
          }
        }
      ],
      customCss: [
        './src/styles/custom.css',
        './src/styles/tailwind.css',
        '@fontsource/inter/400.css',
        '@fontsource/inter/500.css',
        '@fontsource/inter/700.css',
        '@fontsource/ibm-plex-mono/400.css',
        '@fontsource/ibm-plex-mono/600.css'
      ],
      plugins: [
        // https://starlight-links-validator.vercel.app/configuration/#configuration-options
        starlightLinksValidator()
      ]
    })
  ],
  experimental: {
    clientPrerender: true,
    contentCollectionCache: !import.meta.env.DEV
  },
  server: {
    port: Number(process.env.PORT || 4321)
  }
})