2D_Barcode_Scanner_Breakout

import { themes as prismThemes } from 'prism-react-renderer';
import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

// our search keys
const appKey = process.env.ALGOLIA_APP_KEY;
const appID = process.env.ALGOLIA_APPID;
const indexName = process.env.ALGOLIA_INDEX_NAME;

// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)

const config: Config = {
    title: 'SparkFun 2D Barcode Scanner Breakout Documentation',
    tagline: 'Scan and interpret all kinds of barcodes with the SparkFun 2D Barcode Scanner Breakout',
    favicon: 'img/favicon.ico',

    // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
    future: {
        v4: true, // Improve compatibility with the upcoming Docusaurus v4
    },
    // Set the production url of your site here
    url: 'https://docs.sparkfun.com',
    // Set the /<baseUrl>/ pathname under which your site is served
    // For GitHub pages deployment, it is often '/<projectName>/'
    baseUrl: '/2D_Barcode_Scanner_Breakout/',

    // GitHub pages deployment config.
    // If you aren't using GitHub pages, you don't need these.
    organizationName: 'sparkfun', // Usually your GitHub org/user name.
    projectName: '2D_Barcode_Scanner_Breakout', // Usually your repo name.

    onBrokenLinks: 'throw',
    trailingSlash: false,

    // Even if you don't use internationalization, you can use this field to set
    // useful metadata like html lang. For example, if your site is Chinese, you
    // may want to replace "en" with "zh-Hans".
    i18n: {
        defaultLocale: 'en',
        locales: ['en'],
    },
    plugins: [
        '@docsearch/docusaurus-adapter',
    ],
    presets: [
        [
            'classic',
            {
                docs: {
                    sidebarPath: './sidebars.ts',
                    // Please change this to your repo.
                    routeBasePath: '/',
                },
                blog: false,
                theme: {
                    customCss: './src/css/custom.css',
                },
            } satisfies Preset.Options,
        ],
    ],
    // fix a css issue for docsearch - see https://github.com/facebook/docusaurus/issues/11746
    future: {
        v4: true,
        experimental_faster: {
            lightningCssMinimizer: true,
        },
    },
    themeConfig: {
        // Replace with your project's social card
        image: 'img/docusaurus-social-card.jpg',
        colorMode: {
            respectPrefersColorScheme: true,
        },

        docsearch: {
            // The application ID provided by Algolia
            appId: appID,
            apiKey: appKey,
            indexName: indexName,

            // Optional: see doc section below
            contextualSearch: false,

            // Optional: path for search page that enabled by default (`false` to disable it)
            searchPagePath: 'search',

            // Move to it's own index for now - so don't need this.
            //------------------------------------------------------------------
            // NOTE: If using the overall doc index, set  this facet filter up
            //------------------------------------------------------------------
            // // only search in the SparkFun 2D Barcode Scanner Breakout documentation - restrict on the section facet
            searchParameters: {
                facetFilters: ['section:2D_Barcode_Scanner_Breakout'],
            },

            // note - using a "markdown" index that is separate from the main documentation index.
            // this is recommended by docsearch
            //
            // March, 2026 - Normal search used facetFilters to key off the section attribute,
            // to limit search results to a specific section. This allows the same overall index
            // to be used for the 2D Barcode Scanner Breakout.  This is not available for AskAi.
            //
            // see: https://docsearch.algolia.com/docs/api/#askai
            // 
            // It appears - according to the above docs and observation, that the facet filters 
            // are limited to a small set of values. It's an optimization most likely for now.
            ///
            // Sooo - options are to have unique index per doc set - hmmm , or 
            // disabling AskAI for the 2D Barcode Scanner Breakout - can revisit later.
            //
            // disable for now. Wait to see if this evolves, or we feel we need to support
            // ai at this level - then make a new index.
            // using it's own idex March 2026 -
            // askAi: {
            //     indexName: assistantIndexName,
            //     assistantId: assistantId,
            //     apiKey: appKey,
            //     appId: appID,
            //     sidePanel: true,

            // },

        },

        navbar: {
            title: 'SparkFun 2D Barcode Scanner Breakout Hookup Guide',
            logo: {
                alt: 'SparkFun Logo',
                src: 'img/sfe_flame.png',
            },
            items: [
                // {
                //     type: 'docSidebar',
                //     sidebarId: 'tutorialSidebar',
                //     position: 'left',
                //     label: 'Documentation',
                // },
                {
                    href: 'https://github.com/sparkfun/2D_Barcode_Scanner_Breakout',
                    position: 'right',
                    className: 'header-github-link',
                    'aria-label': 'GitHub repository',
                },
                {
                    href: 'https://www.sparkfun.com',
                    position: 'right',
                    className: 'header-sparkfun-link',
                    'aria-label': 'SparkFun website'
                },
                {
                    href: 'https://community.sparkfun.com',
                    position: 'right',
                    className: 'header-forums-link',
                    'aria-label': 'SparkFun Community Forums',
                },
                {
                    href: 'https://docs.sparkfun.com',
                    position: 'right',
                    className: 'header-all-docs-link',
                    'aria-label': 'SparkFun Documentation',
                },
            ],
        },
        footer: {
            logo: {
                alt: 'SparkFun Electronics',
                src: 'img/sfe_flame.png',
                href: 'https://www.sparkfun.com/'
            },
            links: [
                {
                    title: '2D Barcode Scanner Breakout Board (V2)',
                    items: [
                        {
                            label: '2DBarcodeScannerv2',
                            href: 'https://www.sparkfun.com/sparkfun-2d-barcode-scanner-breakout-v2.html'
                        },
                    ],
                },
                {
                    title: 'Social Channels',
                    items: [
                        {
                            html: `<table style="border:none; border-collapse:collapse;">
  <tr style="border:none;">
    <td style="border:none; padding:0;">
      <a href="https://www.youtube.com/sparkfun" target="_blank" rel="noreferrer noopener" aria-label="SparkFun on YouTube">
        <img src="img/social-youtube.svg" class="social-image" alt="SparkFun on YouTube" width="32" height="32" />
      </a>
    </td>
    <td style="border:none; padding:0;">
      <a href="https://www.github.com/sparkfun" target="_blank" rel="noreferrer noopener" aria-label="SparkFun on GitHub">
        <img src="img/social-github.svg" class="social-image" alt="SparkFun on GitHub" width="32" height="32" />
      </a>
    </td>
    <td style="border:none; padding:0;">
      <a href="https://www.instagram.com/sparkfun/" target="_blank" rel="noreferrer noopener" aria-label="SparkFun on Instagram">
        <img src="img/social-instagram.svg" class="social-image" alt="SparkFun on Instagram" width="32" height="32" />
      </a>
    </td>
    <td style="border:none; padding:0;">
      <a href="https://twitter.com/sparkfun" target="_blank" rel="noreferrer noopener" aria-label="SparkFun on Twitter">
        <img src="img/social-twitter.svg" class="social-image" alt="SparkFun on Twitter" width="32" height="32" />
      </a>
    </td>
  </tr>
</table>`
                        }
                    ],
                },
                {
                    title: 'SparkFun',
                    items: [
                        {
                            label: 'Community Forum',
                            href: 'https://community.sparkfun.com/',
                        },
                        {
                            label: 'SparkFun.com',
                            href: 'https://www.sparkfun.com/',
                        },
                    ],
                },
            ],
            copyright: `Copyright © ${new Date().getFullYear()} SparkFun Electronics`,
        },
        prism: {
            theme: prismThemes.github,
            darkTheme: prismThemes.dracula,
        },
    } satisfies Preset.ThemeConfig,
};

export default config;