Feature request: Flag to optionally disable generating titles in markdown links
- Dominant language
- JavaScript
- Stars
- 724
- Forks
- 150
- Avg merge
- 18h 22m
- Merged PRs (30d)
- 4
Description
I use just-the-docs and jekyll to generate a static site based on the markdown generated with this tool.
Unfortunately that stack does not support titles in markdown links so it would be nice with a flag to remove them.
In other words I want a flag which when enabled replaces this:
```markdown
[foo](bar TITLE)
```
With this:
```markdown
[foo](bar)
```
I have created a fork that we currently use to achieve this here: https://github.com/mickem/jsonschema2md/commit/e899a7c9453f5fdb45ae7d3bfb7a1450e93cae82
If there is an interest I could add a PR for this repo.
Contributor guide
Research direction
Start by reviewing the linked fork commit e899a7c9453f5fdb45ae7d3bfb7a1450e93cae82 and tracing the existing Markdown link generation it changes. Confirm the flag's enabled and default behavior against the examples in the issue, with completion shown by links being emitted without titles when requested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100