Skip to content

Admonition toggle arrow should follow similar UI/UX for other projects #48

@choldgraf

Description

@choldgraf

Context

This theme uses an admonition toggle arrow that points "right" when it is "click to open", and "down" when it is "click to close". However, this breaks from convention in a lot of other documentation sites, and I think we should consider just following what those other sites do instead.

For example, a few that I immediately found:

MkDocs: https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admonitions#collapsible-blocks

ShareX_MZABY1A2EI

Quarto:

ShareX_SwLWoOW1Zu

Obsidian:

ShareX_d7SOZlOl6h

There are also a few references in stackfoo that talk about this:

Proposal

Our admonition toggle arrow should follow the same pattern of "point right, click to open", and "point down, click to close". This will more likely map onto user expectations, given the other documentation they have likely interacted with on the internet.

Tasks and updates

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions