Skip to content

Predefined tag lists per plugin/preset #5913

@mambax

Description

@mambax

Have you read the Contributing Guidelines on issues?

Description

Instead of picking tags for blogs and docs randomly, it would be nice to have a predefined set of tags where the writers can only choose from.

Has this been requested on Canny?

No response

Motivation

To our docs contribute now more than 40 people. They all love tags in docs and blogs. The issue arising is that we have the same tag multiple times, like

infra-as-code
infra as code
infrastructure as code
infrastructure-as-code

API design

Allow a tags.yml (or a tagsFilePath) to be assigned to each plugin/preset.

[
      '@docusaurus/plugin-content-blog',
      {
        id: 'cookbook',
        routeBasePath: 'cookbook',
        path: 'cookbook',
        blogSidebarCount: 'ALL',
        blogSidebarTitle: 'All recipes',
        authorsMapPath: '../authors.yml',
        tagsFilePath: '../tagsFile.yml',
        editUrl: ...,
    ],

tagsFile.yml

tags:
  - infrastructure-as-code
  - kubernetes
  • If then users add tags to docs/blog that are not present in the list, the build fails (optionally, warns).
  • If the file is not specified, the current approach would apply
  • This would be similar to the global authors approach where you have only 1 author file

Have you tried building it?

No.

Self-service

  • I'd be willing to contribute this feature to Docusaurus myself.

Metadata

Metadata

Assignees

Labels

apprenticeIssues that are good candidates to be handled by a Docusaurus apprentice / traineedomain: content pluginRelated to content plugin emitting metadata for theme consumptionfeatureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions