question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. ItĀ collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

No documentation on how to use tags with docs pages

See original GitHub issue

šŸ“š Documentation

The release notes say you can now use tags like you can with blogs: https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.5

I don’t think there’s documentation on ā€œhow to use tags with documentation filesā€.

I think you can just use the tags: property in the frontmatter of the .md file, like this?

---
title: Feature documentation
description: Learn about the new feature snorgleborf
tags: [snorgleborf, features]
---

The next version of the docs doesn’t mention tags: https://docusaurus.io/docs/next/create-doc

And the current version of the docs also doesn’t mention tags: https://docusaurus.io/docs/create-doc

Maybe the beta.5 documentation isn’t ready yet/not deployed? Or maybe I’m looking in the wrong place?

Have you read the Contributing Guidelines on issues?

Yes.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:5 (1 by maintainers)

github_iconTop GitHub Comments

1reaction
Josh-Cenacommented, Aug 27, 2021

tags.yml or {tags} config option to override default tags settings like behavior etc, and maybe have the ability to provide a tag description or something…

So we are really getting into this global YAML config thing😹 Tag description sounds good to me, and having a global tags file also prevents typos like ā€œback-endā€ and ā€œbackendā€ becoming two different tags

0reactions
slorbercommented, Aug 27, 2021

Doc PRs welcome if you want to add this.

Also, the website seems to still tag beta.5 as the next version?

Just a deploy failure, fixed now

In fact the tags front matter is more than an array of strings, because you can also set a custom permalink,

Actually, I’m not very fan of this ā€œfeatureā€ that I suspect nobody is using. A tag can end up being declared twice with different permalinks, and first occurrence wins. I’d prefer to actually keep it undocumented and emit a warning on usage someday to see if it’s safe to remove or if it’s relied on. Eventually we could add a tags.yml or {tags} config option to override default tags settings like behavior etc, and maybe have the ability to provide a tag description or something…

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to tag subjects within a single Google Doc
Another option would be to create headings for your various topics in the document and then navigate to them using the document outline...
Read more >
How to tag pages - The MDN Web Docs project
This article explains the best way to tag pages so that our readers ... Document metadata: The writing community uses tags to keep...
Read more >
Tagging pages | Kentico 10 Documentation
Enter the tags in the Page tags field or use the Select button to choose tags from the currently chosen Page tag group...
Read more >
Meta Tags and Attributes that Google Supports | Documentation
Google supports both page-level meta tags and tag attributes. Explore a list of the special tags that Google Search can support.
Read more >
Creating and managing tags - Google Cloud
Open the Tags page in the Google Cloud console. Open Tags page. Select the Project picker at the top of the page. From...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found