Skip to content

chore(ci): create workflow to check the FrontMatter information in markdown #7

@lucaaamaral

Description

@lucaaamaral

Problem

Docussaurus builds the sidebar according to the directory structure, detecting markdown files and listing the pages accordingly.
Docussaurus uses FrontMatter information to add the page's title and metadata.
We have a file sidebars.json with a list of files, check that is being used by the check_sidebars.py script.

Solution

Check if sidebars.json and if the check_sidebars.py is relevant, remove if not, document if it is.
Bring a CI check for presence and conformance of the FrontMatter header.

Non-goals

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions