@mintlify/prebuild/dist/prebuild/generateFavicons.js

Helpful functions for Mintlify's prebuild step

import favicons from 'favicons';
import { promises as _promises } from 'fs';
import { join } from 'path';
const { readFile } = _promises;
export const generateFavicons = async (config, contentDirectoryPath) => {
    if (config.favicon == null)
        return;
    if (typeof config.favicon === 'string') {
        const desiredPath = join(contentDirectoryPath, config.favicon);
        const favicon = await readFile(desiredPath);
        try {
            const icons = await favicons(favicon, faviconConfig(config.name));
            return [icons];
        }
        catch (err) {
            if (typeof err === 'object' && err != null && 'message' in err)
                console.log(err.message); // Error description e.g. "An unknown error has occurred"
        }
    }
    else {
        // Light and dark favicons case
        try {
            const lightPath = join(contentDirectoryPath, config.favicon.light);
            const darkPath = join(contentDirectoryPath, config.favicon.dark);
            const lightFavicon = await readFile(lightPath);
            const darkFavicon = await readFile(darkPath);
            const [lightIcons, darkIcons] = await Promise.all([
                favicons(lightFavicon, faviconConfig(config.name)),
                favicons(darkFavicon, {
                    ...faviconConfig(config.name),
                    path: '/favicons-dark',
                }),
            ]);
            return [lightIcons, darkIcons];
        }
        catch (err) {
            if (typeof err === 'object' && err != null && 'message' in err)
                console.log(err.message);
        }
    }
};
const faviconConfig = (name) => ({
    path: '/favicons', // Path for overriding default icons path. `string`
    appName: name, // Your application's name. `string`
    appShortName: name, // Your application's short_name. `string`. Optional. If not set, appName will be used
    appDescription: undefined, // Your application's description. `string`
    developerName: undefined, // Your (or your developer's) name. `string`
    developerURL: undefined, // Your (or your developer's) URL. `string`
    dir: 'auto', // Primary text direction for name, short_name, and description
    lang: 'en-US', // Primary language for name and short_name
    background: '#fff', // Background colour for flattened icons. `string`
    theme_color: '#fff', // Theme color user for example in Android's task switcher. `string`
    appleStatusBarStyle: 'black-translucent', // Style for Apple status bar: "black-translucent", "default", "black". `string`
    display: 'standalone', // Preferred display mode: "fullscreen", "standalone", "minimal-ui" or "browser". `string`
    orientation: 'any', // Default orientation: "any", "natural", "portrait" or "landscape". `string`
    scope: '/', // set of URLs that the browser considers within your app
    start_url: '/?homescreen=1', // Start URL when launching the application from a device. `string`
    preferRelatedApplications: false, // Should the browser prompt the user to install the native companion app. `boolean`
    relatedApplications: undefined, // Information about the native companion apps. This will only be used if `preferRelatedApplications` is `true`. `Array<{ id: string, url: string, platform: string }>`
    version: '1.0', // Your application's version string. `string`
    logging: false, // Print logs to console? `boolean`
    pixel_art: false, // Keeps pixels "sharp" when scaling up, for pixel art.  Only supported in offline mode.
    loadManifestWithCredentials: true, // Browsers don't send cookies when fetching a manifest, enable this to fix that. `boolean`
    manifestMaskable: false, // Maskable source image(s) for manifest.json. "true" to use default source. More information at https://web.dev/maskable-icon/. `boolean`, `string`, `buffer` or array of `string`
    icons: {
        android: ['android-chrome-192x192.png', 'android-chrome-256x256.png'],
        appleIcon: ['apple-touch-icon.png'],
        appleStartup: false,
        favicons: true,
        windows: ['mstile-150x150.png'],
        yandex: false,
        firefox: false,
    },
});