Skip to content

[Idea] Ways to style the docs based on metadata on defs #188

Open
@bshepherdson

Description

@bshepherdson

I'm documenting an "interface" namespace that's intended to be used by other parts of the codebase. It has many healthy functions that will be around for the longer term, but some need a bit of work, and others only there to support some legacy use cases.

I'd like to be able to put Clojure metadata on the vars like ^:legacy or ^{:health :smelly} and then to define custom CSS classes in Marginalia that will style the docs and/or code regions for those functions in some fashion, perhaps adding a red border on the left edge.

Less nice, but still workable, would be including HTML tags or similar annotations inside the docstrings to achieve the same effect.

Activity

seancorfield

seancorfield commented on Mar 23, 2024

@seancorfield
Member

Interesting suggestion. Do you have more concrete ideas about how specifically you imagine this working from a user perspective?

self-assigned this
on Mar 30, 2024
removed their assignment
on Dec 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

      Participants

      @seancorfield@bshepherdson

      Issue actions

        [Idea] Ways to style the docs based on metadata on `def`s · Issue #188 · clj-commons/marginalia