ex_doc icon indicating copy to clipboard operation
ex_doc copied to clipboard

WIP: Markdown formatter

Open eksperimental opened this issue 1 year ago • 3 comments

Original implementation as discussed in https://github.com/elixir-lang/ex_doc/issues/1962

The generated docs can be seen in this repo: https://github.com/eksperimental/ex_doc_markdown_formatter_docs

This is a WIP. There are many details to fix such as some characters that need to be properly escaped/unescaped.

I would like to get some feedback before moving forward.

My approach was to keep things simple and add things if they are needed.

One challenge was to rewrite the headings levels within docs, since that would break the hierarchical structure of the document.

Screenshots

API REFERENCE image

KERNEL image

KERNEL image

eksperimental avatar Dec 31 '24 21:12 eksperimental

📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/14148102541/artifacts/2844699572

github-actions[bot] avatar Mar 29 '25 17:03 github-actions[bot]

@eksperimental do you need any help with this one?

yordis avatar Apr 28 '25 17:04 yordis

@eksperimental do you need any help with this one?

Hi @yordis. The PR is a proof of concept. As it is now it's OK. There's another PR going on in parallel. I wouldn't invest much more energy on this until we see what's going to happen with the other PR and the direction on this one. I think we need to wait for Jose's input on this. Only then if it's decided to continue with this I think I may use your help as there are plenty of details to be ironed out.

Thanks for the help. I will let know when if the time comes.

eksperimental avatar Apr 29 '25 01:04 eksperimental