🖼️ Ensure favicon is under site.options

.changeset/sixty-actors-love.md

@@ -0,0 +1,6 @@
+---
+'myst-config': patch
+'myst-cli': patch
+---
+
+Favicon on site option is under options.

packages/myst-cli/src/config.ts

@@ -375,9 +375,6 @@ async function resolveSiteConfigPaths(
       }),
     );
   }
-  if (siteConfig.favicon) {
-    resolvedFields.favicon = await resolutionFn(session, path, siteConfig.favicon);
-  }
   if (siteConfig.parts) {
     resolvedFields.parts = await loadFrontmatterParts(
       session,

packages/myst-config/src/site/site.spec.ts

@@ -116,10 +116,20 @@ describe('validateSiteConfig', () => {
       nav: [{ title: 'cool folder', children: [{ title: 'cool page', url: '/test/cool-page' }] }],
       actions: [{ title: 'Go To Example', url: 'https://example.com', static: false }],
       domains: ['test.curve.space'],
-      favicon: 'curvenote.png',
+      options: { favicon: 'curvenote.png' },
     };
     expect(validateSiteConfig(siteConfig, opts)).toEqual(siteConfig);
   });
+  it('valid favicon is moved to options', async () => {
+    const siteConfig = {
+      projects: [{ path: 'my-proj', slug: 'test' }],
+      favicon: 'curvenote.png',
+    };
+    expect(validateSiteConfig(siteConfig, opts)).toEqual({
+      projects: [{ path: 'my-proj', slug: 'test' }],
+      options: { favicon: 'curvenote.png' },
+    });
+  });
   it('invalid list values are filtered', async () => {
     expect(
       validateSiteConfig(

packages/myst-config/src/site/types.ts

@@ -29,7 +29,6 @@ export type SiteConfig = SiteFrontmatter & {
   nav?: SiteNavItem[];
   actions?: SiteAction[];
   domains?: string[];
-  favicon?: string;
   template?: string;
 };
 

packages/myst-config/src/site/validators.ts

@@ -20,15 +20,7 @@ import {
 import type { SiteAction, SiteConfig, SiteNavItem, SiteProject } from './types.js';
 
 export const SITE_CONFIG_KEYS = {
-  optional: [
-    ...SITE_FRONTMATTER_KEYS,
-    'projects',
-    'nav',
-    'actions',
-    'domains',
-    'favicon',
-    'template',
-  ],
+  optional: [...SITE_FRONTMATTER_KEYS, 'projects', 'nav', 'actions', 'domains', 'template'],
   alias: FRONTMATTER_ALIASES,
 };
 
@@ -150,9 +142,6 @@ export function validateSiteConfigKeys(
     );
     if (domains) output.domains = [...new Set(domains)];
   }
-  if (defined(value.favicon)) {
-    output.favicon = validateString(value.favicon, incrementOptions('favicon', opts));
-  }
   if (defined(value.template)) {
     output.template = validateString(value.template, incrementOptions('template', opts));
   }