Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add markdown formatter / exporter #1976

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

add markdown formatter / exporter #1976

wants to merge 1 commit into from
+396 −2

Conversation

mayel
Copy link
Contributor

@mayel mayel commented Dec 8, 2024

josevalim
josevalim reviewed Dec 9, 2024
View reviewed changes
lib/ex_doc/cli.ex
@@ -103,7 +103,7 @@ defmodule ExDoc.CLI do
defp normalize_formatters(opts) do
formatters =
case Keyword.get_values(opts, :formatter) do
[] -> opts[:formatters] || ["html", "epub"]
[] -> opts[:formatters] || ["html", "epub", "markdown"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we shuold enable it by default :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I misread and thought that was the allow-list of supported formatters

josevalim
josevalim reviewed Dec 9, 2024
View reviewed changes
lib/ex_doc/formatter/markdown.ex
|> Enum.map(&elem(&1, 1))
end

defp generate_zip(output) do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should skip the zip as well. The simplest we can genereate the best :)

@josevalim
Copy link
Member

Thank you @mayel, I think the general direction is good and I think we can continue exploring it. The testing structure will be very important too.

Just a heads up, we will be slow with reviews on our side, since we are focused on Elixir v1.18 and launching Livebook Teams.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@josevalim josevalim josevalim left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mayel @josevalim