Skip to content

Use tabbed code blocks to make the spec easier to read #580

@letmaik

Description

@letmaik

Currently, the spec shows examples in multiple serializations, where typically people are only interested in a single format depending on their use case, in my case this is JSON.

Lots of docs out there which have multiple snippet variants use tabs. Ideally, all tabs are linked, so switching one snippet to JSON switches all of them. I think SPDX would benefit from the same.

For mkdocs, there are extensions for this purpose, an example is shown here: https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#configuration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    website improvementArea where the project website needs fixing

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions