Standalone markdown support #1234
Merged
Conversation
This file contains 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
gpetiot
approved these changes
Nov 11, 2024
|
I imagine this will close #1213 |
Co-authored-by: Daniel Bünzli <[email protected]> Co-authored-by: Paul-Elliot Anglès d'Auriac <[email protected]>
Co-authored-by: Paul-Elliot <[email protected]>
Co-authored-by: Paul-Elliot <[email protected]>
Co-authored-by: Daniel Bünzli <[email protected]> Co-authored-by: Paul-Elliot <[email protected]>
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.
This PR adds a new package,
odoc-md, that can process markdown files and outputpage-*.odocfiles to be linked and then turned into HTML/man/whatever byodoc. It's based on previous work by @dbuenzli and @panglesd, but is more limited in scope. There is no support for odoc-style references in markdown, as the main intent is to be able to render the various markdown-formatted files thatvoodoocurrently does for ocaml.org (e.g. https://ocaml.org/p/odoc/latest/README.md.html).odoc-mdis based on cmarkit, which has an OCaml lower bound of 4.14, which is why this is a new package rather than part of the odoc package.