WIP: Markdown formatter #1992
Open
WIP: Markdown formatter #1992
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
leandrocp
reviewed
Mar 25, 2025
leandrocp
reviewed
Mar 26, 2025
|
📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/14148102541/artifacts/2844699572 |
|
@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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Original implementation as discussed in #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
KERNEL
KERNEL
