chore: add top-level attribute

jupyter-book · May 15, 2024 · d6055d7 · d6055d7
1 parent 2fa354d
commit d6055d7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/packages/myst-frontmatter/src/exports/types.ts b/packages/myst-frontmatter/src/exports/types.ts
@@ -24,6 +24,7 @@ export type Export = {
   zip?: boolean;
   toc?: any[];
   articles?: ExportArticle[];
+  top_level?: 'parts' | 'chapters' | 'sections';
   /** sub_articles are only for jats xml export */
   sub_articles?: string[];
   /** MECA: to, from later */

diff --git a/packages/myst-frontmatter/src/exports/validators.ts b/packages/myst-frontmatter/src/exports/validators.ts
@@ -3,6 +3,7 @@ import {
   defined,
   incrementOptions,
   validateBoolean,
+  validateChoice,
   validateEnum,
   validateList,
   validateNumber,
@@ -28,6 +29,7 @@ const EXPORT_KEY_OBJECT = {
     'name',
     'renderer',
     'articles',
+    'top_level',
     'sub_articles',
   ],
   alias: {
@@ -238,6 +240,12 @@ export function validateExport(input: any, opts: ValidationOptions): Export | un
       validExport.articles = undefined;
     }
   }
+  if (defined(value.top_level)) {
+    validExport.top_level = validateChoice(value.top_level || 'sections', {
+      ...incrementOptions('top_level', opts),
+      choices: ['parts', 'chapters', 'sections'],
+    }) as Export['top_level'];
+  }
   if (defined(value.sub_articles)) {
     if (validExport.format !== ExportFormats.xml) {
       validationError("sub_articles are only supported for 'jats' export", opts);