Added flag link-title to remove titles from markdown links#470
Open
mickem wants to merge 3 commits intoadobe:mainfrom
Open
Added flag link-title to remove titles from markdown links#470mickem wants to merge 3 commits intoadobe:mainfrom
mickem wants to merge 3 commits intoadobe:mainfrom
Conversation
…links Added flag (--no-titles-in-links) to skip generating titles in links as this is not supported by jekyll and just-the-docs
Codecov Report
@@ Coverage Diff @@
## main #470 +/- ##
=======================================
Coverage 99.75% 99.75%
=======================================
Files 11 11
Lines 2040 2067 +27
=======================================
+ Hits 2035 2062 +27
Misses 5 5
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
trieloff
approved these changes
Jan 27, 2023
Collaborator
trieloff
left a comment
trieloff
left a comment
There was a problem hiding this comment.
Looks good. There is still a merge conflict that I'd ask you to resolve before I can merge this.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Some markdown tools do not work correctly with titles in markdown (for instance jekyll/just-the-docs).
Here is a solution for this which works by adding a command line flag (link-title) which when set to false will remove all titles from markdown links.
jsonschema2md -d schemas -t falseThe resulting output will turn from:
to:
As suggested in #469 this is a PR to implement the functionality (now with reverted flag)