Skip to content

Commit cbc1367

Browse files
committed
Update documentation task to include 'markdown' as an additional formatter option
1 parent 682cf4d commit cbc1367

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

lib/mix/tasks/docs.ex

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ defmodule Mix.Tasks.Docs do
1212
* `--canonical`, `-n` - Indicate the preferred URL with
1313
`rel="canonical"` link element, defaults to no canonical path
1414
15-
* `--formatter`, `-f` - Which formatters to use, `html` or
16-
`epub`. This option can be given more than once. By default,
17-
both `html` and `epub` are generated.
15+
* `--formatter`, `-f` - Which formatters to use, `html`,
16+
`epub`, or `markdown`. This option can be given more than once. By default,
17+
`html`, `epub`, and `markdown` are generated.
1818
1919
* `--language` - Specifies the language to annotate the
2020
EPUB output in valid [BCP 47](https://tools.ietf.org/html/bcp47)
@@ -130,7 +130,7 @@ defmodule Mix.Tasks.Docs do
130130
against the complete module name (which includes the "Elixir." prefix for
131131
Elixir modules). If a module has `@moduledoc false`, then it is always excluded.
132132
133-
* `:formatters` - Formatter to use; default: ["html", "epub"], options: "html", "epub".
133+
* `:formatters` - Formatter to use; default: ["html", "epub", "markdown"], options: "html", "epub", "markdown".
134134
135135
* `:groups_for_extras`, `:groups_for_modules`, `:groups_for_docs`, and `:default_group_for_doc` -
136136
See the "Groups" section
@@ -644,7 +644,7 @@ defmodule Mix.Tasks.Docs do
644644
defp normalize_formatters(options) do
645645
formatters =
646646
case Keyword.get_values(options, :formatter) do
647-
[] -> options[:formatters] || ["html", "epub"]
647+
[] -> options[:formatters] || ["html", "epub", "markdown"]
648648
values -> values
649649
end
650650

0 commit comments

Comments
 (0)