Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Content with kind: page cannot have name field #369

Open
gadenbuie opened this issue Oct 8, 2024 · 0 comments
Open

Content with kind: page cannot have name field #369

gadenbuie opened this issue Oct 8, 2024 · 0 comments

Comments

@gadenbuie
Copy link
Contributor

If you try to include a page with a name field, e.g.

quartodoc:
  sections:
    - title: Brand Components
      desc: Individual brand components.
      contents:
        - kind: page
          path: brand-meta
          name: Metadata
          contents: 
            - meta.BrandMeta

You'll get a confusing error

ValueError: Configuration error for YAML:
 - unexpected value; permitted: 'auto': `kind` for element 0 in the list for `contents` located in element 0 in the list for `sections`

The missing context is that the presence of name: Metadata is driving the kind: auto requirement. The correct syntax appears to be

quartodoc:
  sections:
    - title: Brand Components
      desc: Individual brand components.
      contents:
        - kind: page
          path: brand-meta
          summary:
            name: Metadata
          contents: 
            - meta.BrandMeta

but I didn't see that syntax anywhere on https://machow.github.io/quartodoc/get-started/basic-content.html#documenting-source-files-that-are-not-a-package (I found it by searching GitHub for other kind: page examples).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant