Skip to content

WIP: Markdown formatter #1992

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

WIP: Markdown formatter #1992

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6265dd4
Port Markdown formatter from HTML
eksperimental Nov 26, 2024
80c42db
Add Markdown formatter option
eksperimental Nov 26, 2024
df17551
First working version of Markdown documentation
eksperimental Nov 26, 2024
d0cca8d
Update Markdown formatter to be aligned with changes in HTML formatte…
eksperimental Dec 30, 2024
ce76b7e
Remove duplicate entries and assets folder in .build file
eksperimental Dec 31, 2024
44bcc9f
Update :mdex to v0.3.0
eksperimental Dec 31, 2024
97cef3e
Minor fix
eksperimental Dec 31, 2024
a156122
Update dep version for mdex
eksperimental Dec 31, 2024
65cc8cb
Merge branch 'main' into feature/markdown-formatter
eksperimental Mar 28, 2025
d666704
Update mdex dependency
eksperimental Mar 28, 2025
044203a
Do not rely on ExDoc.Utils.source_url_pattern/3
eksperimental Mar 29, 2025
805b8ba
Bump levels using Access protocol
eksperimental Mar 29, 2025
88590a1
Run: mix deps.unlock --unused
eksperimental Mar 29, 2025
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
4 changes: 4 additions & 0 deletions bin/ex_doc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Code.prepend_path Path.expand("../_build/#{mix_env}/lib/makeup_elixir/ebin", __D
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/makeup_erlang/ebin", __DIR__)
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/makeup_html/ebin", __DIR__)
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/earmark_parser/ebin", __DIR__)
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/rustler_precompiled/ebin", __DIR__)
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/castore/ebin", __DIR__)
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/jason/ebin", __DIR__)
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/mdex/ebin", __DIR__)
Code.prepend_path Path.expand("../_build/#{mix_env}/lib/ex_doc/ebin", __DIR__)

if Code.ensure_loaded?(ExDoc.CLI) do
Expand Down
7 changes: 6 additions & 1 deletion lib/ex_doc.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,16 @@ defmodule ExDoc do
end

defp find_formatter(name) do
[ExDoc.Formatter, String.upcase(name)]
[ExDoc.Formatter, modname(name)]
|> Module.concat()
|> check_formatter_module(name)
end

defp modname("epub"), do: EPUB
defp modname("html"), do: HTML
defp modname("markdown"), do: Markdown
defp modname(_), do: nil

defp check_formatter_module(modname, argname) do
if Code.ensure_loaded?(modname) do
modname
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_doc/cli.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ defmodule ExDoc.CLI do
--canonical Indicate the preferred URL with rel="canonical" link element
-c, --config Give configuration through a file instead of a command line.
See "Custom config" section below for more information.
-f, --formatter Docs formatter to use (html or epub), default: html and epub
-f, --formatter Docs formatter to use (html, epub or markdown), default: html and epub
--homepage-url URL to link to for the site name
--language Identify the primary language of the documents, its value must be
a valid [BCP 47](https://tools.ietf.org/html/bcp47) language tag, default: "en"
Expand Down
Loading