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
42 changes: 29 additions & 13 deletions lib/ex_doc/formatter/markdown.ex
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ defmodule ExDoc.Formatter.MARKDOWN do
all_files =
generate_nav(config, modules, tasks, extras) ++
generate_api_reference(config, modules, tasks) ++
generate_extras(extras, config) ++
generate_extras(config, extras) ++
generate_list(config, modules) ++
generate_list(config, tasks)

Expand All @@ -34,11 +34,14 @@ defmodule ExDoc.Formatter.MARKDOWN do
extras = group_by_group(extras)

content =
Templates.llms_txt_template(config, modules, mix_tasks, extras)
config
|> Templates.llms_txt_template(modules, mix_tasks, extras)
|> normalize_output()

filename = "llms.txt"
File.write(Path.join(config.output, filename), content)

write!(config, filename, content)

[filename]
end

Expand All @@ -51,11 +54,14 @@ defmodule ExDoc.Formatter.MARKDOWN do
mix_tasks = group_by_group(tasks)

content =
Templates.api_reference_template(config, modules, mix_tasks)
config
|> Templates.api_reference_template(modules, mix_tasks)
|> normalize_output()

filename = "api-reference.md"
File.write(Path.join(config.output, filename), content)

write!(config, filename, content)

[filename]
end

Expand All @@ -65,30 +71,40 @@ defmodule ExDoc.Formatter.MARKDOWN do
|> Enum.map(&{hd(&1).group, &1})
end

defp generate_extras(extras, config) do
for %ExDoc.ExtraNode{id: id, source_doc: source_doc} <- extras do
defp generate_extras(config, extras) do
for %ExDoc.ExtraNode{id: id, source_doc: content} <- extras do
filename = "#{id}.md"
output = Path.join(config.output, filename)
File.write!(output, source_doc)

write!(config, filename, content)

filename
end
end

defp generate_list(config, nodes) do
nodes
|> Task.async_stream(&generate_module(&1, config), timeout: :infinity)
|> Task.async_stream(&generate_module(config, &1), timeout: :infinity)
|> Enum.map(&elem(&1, 1))
end

## Helpers

defp generate_module(module_node, config) do
defp generate_module(config, module_node) do
content =
Templates.module_template(config, module_node)
config
|> Templates.module_template(module_node)
|> normalize_output()

filename = "#{module_node.id}.md"
File.write(Path.join(config.output, filename), content)

write!(config, filename, content)

filename
end

defp write!(config, filename, content) do
config.output
|> Path.join(filename)
|> File.write!(content)
end
end
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# <%= config.project %> v<%= config.version %> - Table of Contents
<%= if config.description do %>
<%= config.description %>
> <%= config.description %>

<% end %>
<%= nav_group_template config.extra_section, extras %>
Expand Down