👩‍⚖️ Add copyright to frontmatter (#1035)

jupyter-book · Mar 27, 2024 · 6f0183d · 6f0183d
1 parent ebe6581
commit 6f0183d
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 0 deletions.
diff --git a/.changeset/lemon-days-leave.md b/.changeset/lemon-days-leave.md
@@ -0,0 +1,5 @@
+---
+'myst-frontmatter': patch
+---
+
+Add copyright to frontmatter
diff --git a/docs/frontmatter.md b/docs/frontmatter.md
@@ -109,6 +109,9 @@ The following table lists the available frontmatter fields, a brief description
 * - `license`
   - a license object or a string
   - page can override project
+* - `copyright`
+  - a string
+  - page can override project
 * - `funding`
   - a funding object
   - page can override project

diff --git a/packages/myst-frontmatter/src/page/validators.ts b/packages/myst-frontmatter/src/page/validators.ts
@@ -31,6 +31,7 @@ export const USE_PROJECT_FALLBACK = [
   'numbering',
   'keywords',
   'funding',
+  'copyright',
   'affiliations',
 ];
 

diff --git a/packages/myst-frontmatter/src/project/project.yml b/packages/myst-frontmatter/src/project/project.yml
@@ -58,6 +58,7 @@ cases:
         - requirements.txt
       resources:
         - my-script.sh
+      copyright: Authors et al.
     normalized:
       id: my/project
       title: frontmatter
@@ -109,6 +110,7 @@ cases:
         - requirements.txt
       resources:
         - my-script.sh
+      copyright: Authors et al.
   - title: boolean numbering is valid
     raw:
       numbering: 'false'
@@ -174,3 +176,8 @@ cases:
         what: ok
     warnings: 1
     normalized: {}
+  - title: invalid copyright errors
+    raw:
+      copyright: {}
+    normalized: {}
+    errors: 1
diff --git a/packages/myst-frontmatter/src/site/types.ts b/packages/myst-frontmatter/src/site/types.ts
@@ -18,6 +18,7 @@ export type SiteFrontmatter = {
   github?: string;
   keywords?: string[];
   funding?: Funding[];
+  copyright?: string;
   contributors?: Contributor[];
   options?: Record<string, any>;
 };
diff --git a/packages/myst-frontmatter/src/site/validators.ts b/packages/myst-frontmatter/src/site/validators.ts
@@ -33,6 +33,7 @@ export const SITE_FRONTMATTER_KEYS = [
   'keywords',
   'affiliations',
   'funding',
+  'copyright',
   'options',
 ];
 
@@ -159,6 +160,9 @@ export function validateSiteFrontmatterKeys(value: Record<string, any>, opts: Va
       },
     );
   }
+  if (defined(value.copyright)) {
+    output.copyright = validateString(value.copyright, incrementOptions('copyright', opts));
+  }
   if (defined(value.options)) {
     const optionsOptions = incrementOptions('options', opts);
     const options = validateObject(value.options, optionsOptions);