Allow listing outside URLs in extras #2103
Conversation
This makes it possible to delcare URLs as extras and have them listed as links in the sidebar. For example, to set a "Wikipedia" url: ```elixir extras: [ "Wikipedia": [url: "https://wikipedia.com"] ] ``` Closes elixir-lang#2084
sorentwo
force-pushed
the
allow-extra-urls
branch
from
68d3c53 to
639afcc
Compare
| if custom_search_data = map[:search_data] do | ||
| extra_search_data(map, custom_search_data) | ||
| else |
There was a problem hiding this comment.
Added a clause for this rather than a conditional in the function body.
|
For the |
|
Suggestions applied, changes made , and residual TODO items addressed. This is all set! |
| @@ -59,6 +59,7 @@ export function initialize () { | |||
| const items = [] | |||
| const hasHeaders = Array.isArray(node.headers) | |||
| const translate = hasHeaders ? undefined : 'no' | |||
| const href = node?.url || `${node.id}.html` | |||
There was a problem hiding this comment.
Should we add an icon, such as this one, for URLs?
If so, you can upload this bundle to remixicon.com, add external link, and get the new font back: https://github.com/elixir-lang/ex_doc/blob/main/assets/fonts/RemixIconCollection.remixicon
|
@josevalim Suggestions and changes made, ready for another pass |
|
@josevalim Updated! |
|
Closing and reopening to kick CI back to life. |
|
📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/14684053427/artifacts/3015141536 |
|
💚 💙 💜 💛 ❤️ |
This makes it possible to delcare URLs as extras and have them listed as links in the sidebar. For example, to set a "Wikipedia" url:
This is currently light on some validations. I'll expand the tests and URI validation if the approach is improved.
Validate theurlvalue is an actual URIExpand formatter testsurloptionsCloses #2084