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
| defp normalize_extras(base) when is_binary(base), do: {base, %{}} | ||
| defp normalize_extras({base, opts}), do: {base, Map.new(opts)} |
There was a problem hiding this comment.
This is purely for pattern matching to flatten out build_extra/5. The alternative was a cond in build_extra/5, but this seemed a little clearer.
| source_path: input_options[:url], | ||
| source_url: input_options[:url], |
There was a problem hiding this comment.
These probably aren't necessary now.
There was a problem hiding this comment.
Yes, we probably don't need id, source_path, source_url and title_content, as those are all about the rendered page.
| 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.
| txid = | ||
| cond do | ||
| filename = opts[:filename] -> filename | ||
| url = opts[:url] -> url |
There was a problem hiding this comment.
I am pretty sure you want to skip the :url in this case, because this is used to convert something like [foo](foo.md) into a link for foo.html, but there is nothing to link to in the URL case.
|
For the |
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.
urlvalue is an actual URIurloptionsCloses #2084