Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
bshepherdson opened this issue Mar 21, 2024 · 1 comment
Open

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

bshepherdson opened this issue Mar 21, 2024 · 1 comment

Comments

@bshepherdson
Copy link

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.

@seancorfield
Copy link
Member

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

@seancorfield seancorfield self-assigned this Mar 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants