Skip to content

Setting id frontmatter unexpectedly affects the published path of a document #10496

@chriswhong

Description

@chriswhong

Have you read the Contributing Guidelines on issues?

Description

We recently discovered that setting id in the frontmatter has the same effect as setting slug, specifically it will set the path of the document to /{id} instead of /{filename}.

The documentation describes this value as "A unique document ID.", and does not mention this important side effect.

I was able to track this down to https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-plugin-content-docs/src/docs.ts#L143, but I am still unclear about the intent of reading frontMatter.id here and using it instead of unprefixedFilename if it exists.

So, I am not sure if this is a bug, or a documentation issue. I think if there's already a way to override using the filename as the path (by setting slug frontmatter), setting id should not also change it. If this is intentional for whatever reason, we should update the documentation to mention that setting this will also change the path.

Self-service

  • I'd be willing to address this documentation request myself.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationThe issue is related to the documentation of Docusaurus

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions