Skip to content
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.

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

Added flag link-title to remove titles from markdown links #470

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

Conversation

mickem
Copy link

@mickem mickem commented Dec 20, 2022

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 false

The resulting output will turn from:

*   [Foo](./bar.md "This is the title")`id`

to:

*   [Foo](./bar.md) – `id`

As suggested in #469 this is a PR to implement the functionality (now with reverted flag)

…links

Added flag (--no-titles-in-links) to skip generating titles in links as this is not supported by
jekyll and just-the-docs
@mickem mickem closed this Dec 20, 2022
@mickem mickem reopened this Dec 20, 2022
@codecov
Copy link

codecov bot commented Dec 20, 2022

Codecov Report

Merging #470 (3d4c466) into main (3ea00a4) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #470   +/-   ##
=======================================
  Coverage   99.75%   99.75%           
=======================================
  Files          11       11           
  Lines        2040     2067   +27     
=======================================
+ Hits         2035     2062   +27     
  Misses          5        5           
Impacted Files Coverage Δ
lib/index.js 99.71% <100.00%> (+<0.01%) ⬆️
lib/markdownBuilder.js 99.55% <100.00%> (+<0.01%) ⬆️
lib/readmeBuilder.js 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Collaborator

@trieloff trieloff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. There is still a merge conflict that I'd ask you to resolve before I can merge this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants