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

Add purple coloring for todo-admonitions #2526

Merged
merged 4 commits into from
Sep 2, 2024
Merged

Add purple coloring for todo-admonitions #2526

merged 4 commits into from
Sep 2, 2024

Conversation

fredrikekre
Copy link
Member

@fredrikekre fredrikekre commented Jun 12, 2024

No description provided.

@mortenpi
Copy link
Member

Where is this actually used in practice? This is not a standard admonition supported by the Markdown stdlib, right? My view generally has been that we only style admonitions that are also supported by the REPL etc., and custom stuff should be a plugin.

Could we add an example of it here?

###### Info admonition
!!! info "'info' admonition"
This is a `!!! info`-type admonition. This is the same as a `!!! note`-type.
###### Tip admonition
!!! tip "'tip' admonition"
This is a `!!! tip`-type admonition.
###### Warning admonition
!!! warning "'warning' admonition"
This is a `!!! warning`-type admonition.
###### Danger admonition
!!! danger "'danger' admonition"
This is a `!!! danger`-type admonition.
###### Compat admonition
!!! compat "'compat' admonition"
This is a `!!! compat`-type admonition.

@fredrikekre
Copy link
Member Author

Where is this actually used

I just wanted nicely formatted todo-notes in the docs :) I can of course just add the necessary CSS locally.

@mortenpi
Copy link
Member

I think my inclination here is not to deviate from the Markdown stdlib and the Julia REPL 🙁 I only wish it was easier to customize the themes and admonitions though. The ability to add custom ones would be useful though.

@fredrikekre
Copy link
Member Author

I guess I just have to patch Markdown and REPL first then :)

@fredrikekre fredrikekre marked this pull request as draft June 13, 2024 08:54
@mortenpi
Copy link
Member

I guess I just have to patch Markdown and REPL first then :)

That's definitely one way to go about it 🤣

@fredrikekre
Copy link
Member Author

fredrikekre added a commit to JuliaLang/julia that referenced this pull request Jun 27, 2024
This patch adds magenta coloring for `!!! todo` admonitions in addition
to the existing styling of `danger`, `warning`, `info`, `note`, `tip`,
and `compat` admonitions. This is useful if you want to leave some more
colorful todo notes in docstrings, for example.

Accompanying PR for Documenter to render these in HTML and PDF docs:
JuliaDocs/Documenter.jl#2526.
fredrikekre added a commit to JuliaLang/julia that referenced this pull request Jul 12, 2024
This patch adds magenta coloring for `!!! todo` admonitions in addition
to the existing styling of `danger`, `warning`, `info`, `note`, `tip`,
and `compat` admonitions. This is useful if you want to leave some more
colorful todo notes in docstrings, for example.

Accompanying PR for Documenter to render these in HTML and PDF docs:
JuliaDocs/Documenter.jl#2526.
@fredrikekre fredrikekre marked this pull request as ready for review July 12, 2024 15:13
@fredrikekre fredrikekre requested a review from mortenpi July 12, 2024 15:13
Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. @fredrikekre, it's good to go, right? Sorry, this slipped through the cracks.

image

image

@mortenpi mortenpi added Type: Enhancement Format: HTML Related to the default HTML output labels Sep 2, 2024
@fredrikekre fredrikekre merged commit e7df2bc into master Sep 2, 2024
25 checks passed
@fredrikekre fredrikekre deleted the fe/todo branch September 2, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants