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

Check if metadata is present in build script #20

Open
kkerti opened this issue Apr 15, 2024 · 0 comments
Open

Check if metadata is present in build script #20

kkerti opened this issue Apr 15, 2024 · 0 comments

Comments

@kkerti
Copy link
Contributor

kkerti commented Apr 15, 2024

On each page in this docusaurus 2.0 project, the meta data between the --- --- semantics are used for page title, description, tags and other details.

The documentation writers should pay attention the these tags, but sometimes they can be forgotten.

  • Create a a script which checks the created pages, if they have the following meta data on the top: description, title, pageImg, slug
  • Throw error during build if any of the pages don't have the above 4 fields
  • Make the error editor friendly, show which page caused error: has missing field tags!
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