docs: document doc tags + refinements

[Josh-Cena]

Motivation

Resolve #5432. Also added prettier-ignore directives to prevent extra new-lines from being added.

Have you read the Contributing Guidelines on pull requests?

Yes

[netlify]

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 54c51e1

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6128fe916f4f810008057c52

😎 Browse the preview: https://deploy-preview-5433--docusaurus-2.netlify.app

[github-actions]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟢 Performance	97
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

Lighthouse ran on https://deploy-preview-5433--docusaurus-2.netlify.app/

[netlify]

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: b01e9f9

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6128ff00a2383d00083640af

😎 Browse the preview: https://deploy-preview-5433--docusaurus-2.netlify.app

[HonkingGoose]

I've just tested Docusaurus beta.5 and this also works fine:

tags: [Demo, Getting Started]

Do you only want to show one way, or do you want to show both the list-format and the array-format?

[Josh-Cena]

Um, they are both valid YAML formats anyways, not sure if the purpose here is to educate writing valid YAML objects

P.S. I actually prefer writing tags: [Demo, Getting Started]😁 But for several reasons:

• tags: [Demo, Getting Started] is already demonstrated in blog front matter documentation and init template so users should realize it's valid
• The - Demo syntax involves less programmatic construct (less JSONic) so it may be more readable

I in the end chose the YAML format instead of JSON

[HonkingGoose]

Oh I never knew that the Markdown frontmatter is supposed to be a valid YAML object. I learned something new today... 😄

I'll let you decide what you like to do here. 😉

[slorber]

Thanks 👍

I don't feel like this is the best place to document this, but at the same time it's probably overkill to create a new page just for that 🤪 so it will be fine for now