Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion lib/ex_doc/formatter/markdown.ex
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ defmodule ExDoc.Formatter.MARKDOWN do
def run(config, project_nodes, extras) when is_map(config) do
File.mkdir_p!(config.output)

static_files =
if Enum.all?(config.assets, fn {_k, target_dir} ->
config.output |> Path.join(target_dir) |> File.exists?()
end) do
[]
else
ExDoc.Formatter.copy_assets(config.assets, config.output)
end

{modules, tasks} =
project_nodes
|> Enum.filter(&(&1.source_format == "text/markdown"))
Expand All @@ -16,7 +25,8 @@ defmodule ExDoc.Formatter.MARKDOWN do
generate_api_reference(config, modules, tasks) ++
generate_extras(config, extras) ++
generate_list(config, modules) ++
generate_list(config, tasks)
generate_list(config, tasks) ++
static_files

entrypoint = config.output |> Path.join("llms.txt") |> Path.relative_to_cwd()
%{entrypoint: entrypoint, build: List.flatten(all_files)}
Expand Down
24 changes: 24 additions & 0 deletions test/ex_doc/formatter/markdown_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -288,4 +288,28 @@ defmodule ExDoc.Formatter.MarkdownTest do
"*Consult [api-reference.md](api-reference.md) for complete listing*"
end
end

describe "assets" do
test "copies assets from source", %{tmp_dir: tmp_dir} = context do
dir_name = Path.join(tmp_dir, "hello")
File.mkdir!(dir_name)
dir_name |> Path.join("world") |> File.touch!()

config = config(context, assets: %{dir_name => "assets"})

generate(config)

assert File.regular?(tmp_dir <> "/assets/world")
end

test "does not override previous work from other formatters", %{tmp_dir: tmp_dir} = context do
dir_name = Path.join(tmp_dir, "assets")
File.mkdir!(dir_name)
info = File.stat!(dir_name)
config = config(context, assets: %{"test/tmp/markdown_assets/hello" => "assets"})
generate(config)

assert File.stat!(dir_name) == info
end
end
end