Coder Social home page Coder Social logo

strip markdown links about chandler HOT 7 CLOSED

glensc avatar glensc commented on July 17, 2024
strip markdown links

from chandler.

Comments (7)

mattbrictson avatar mattbrictson commented on July 17, 2024

Thanks for the report. Perhaps Chandler is misinterpreting your changelog. I'll take a look.

from chandler.

mattbrictson avatar mattbrictson commented on July 17, 2024

So, the problem is that Chandler doesn't really understand Markdown. It simply splits up the changelog by section heading. For example, in your changelog it uses this chunk for 4.0.0:

## [4.0.0] - 2016-11-23

 - replace xmlrpc implementation with phpxmlrpc/phpxmlrpc, [#1]

This is the text that Chandler submits to GitHub. Since the footnote for [#1] is not included, GitHub doesn't know that [#1] is supposed to be a link. So it interprets it verbatim, which is why you still see the brackets in the release notes on GitHub.

(The reason that GitHub still makes #1 a hyperlink is coincidental: GitHub automatically turns anything that looks like an issue/pull request number into a link.)

You have a couple of options:

  1. Remove the hyperlinks entirely. GitHub will still atomically recognize them as links because they follow the issue/pull request auto-linking format.
  2. Use inline Markdown links, like this: [link](http://url).
  3. Move the footnote into the same section as the link, as follows:
## [4.0.0] - 2016-11-23

 - replace xmlrpc implementation with phpxmlrpc/phpxmlrpc, [#1]

[#1]: https://github.com/eventum/rpc/pull/1

I think making Chandler intelligently parse and reformat Markdown footnotes is too complicated and is beyond my intended scope for this project. Let me know if the workarounds I described above are an acceptable fix from your perspective.

from chandler.

glensc avatar glensc commented on July 17, 2024

thanks for the detailed review, but unfortunately i knew it all before, and do not want to make links inline, and it still doesn't solve [4.0.0] brackets issue.

that's why i submitted this issue for chandler to strip the []-s.

i was thinking that either just dumb strip of them, or parse whole document and detect if the 4.0.0 (example) used to be a link, if yes strip, if not, keep the []-s.

from chandler.

glensc avatar glensc commented on July 17, 2024

ok, i need to move 4.0.0 also to the same section

from chandler.

glensc avatar glensc commented on July 17, 2024

however, 4.0.0 will be included in title area, so there can't be link, the []'s must be stripped.

btw, i'm following keepachangelog

from chandler.

glensc avatar glensc commented on July 17, 2024

ok, solved the [#1]-issue by moving footnotes to same version section. however the title issue is from #24: chandler sets it to 3.0.0, but i wish it to be 3.0.0 - 2014-11-27 as the line in changelog file.

from chandler.

mattbrictson avatar mattbrictson commented on July 17, 2024

Thanks for following up. I'll consider this issue resolved.

from chandler.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.