{"action":"created","issue":{"url":"https://api.github.com/repos/lsegal/yard/issues/863","labels_url":"https://api.github.com/repos/lsegal/yard/issues/863/labels{/name}","comments_url":"https://api.github.com/repos/lsegal/yard/issues/863/comments","events_url":"https://api.github.com/repos/lsegal/yard/issues/863/events","html_url":"https://github.com/lsegal/yard/issues/863","id":74264285,"number":863,"title":"Rewrite local markdown links to markdown files","user":{"login":"mvz","id":10898,"avatar_url":"https://avatars.githubusercontent.com/u/10898?v=3","gravatar_id":"","url":"https://api.github.com/users/mvz","html_url":"https://github.com/mvz","followers_url":"https://api.github.com/users/mvz/followers","following_url":"https://api.github.com/users/mvz/following{/other_user}","gists_url":"https://api.github.com/users/mvz/gists{/gist_id}","starred_url":"https://api.github.com/users/mvz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mvz/subscriptions","organizations_url":"https://api.github.com/users/mvz/orgs","repos_url":"https://api.github.com/users/mvz/repos","events_url":"https://api.github.com/users/mvz/events{/privacy}","received_events_url":"https://api.github.com/users/mvz/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2015-05-08T07:23:11Z","updated_at":"2015-05-09T20:03:41Z","closed_at":"2015-05-09T20:03:41Z","body":"I'm trying to get the documentation as generated by YARD in order for [reek](https://github.com/troessner/reek). In the README.md and elsewhere we are using Markdown formatted links to other markdown files in the same repository. This works out very nicely when viewing the files on GitHub, but all the links are broken when the documentation is generated by `yardoc`, because it generates files with a different extension and relative path.\r\n\r\nAn alternative is to use the `{file: ...}` syntax, but that isn't part of standard markdown so leaves ugly bits when rendered, e.g., on GitHub.\r\n\r\nIt would be very nice if YARD could detect local markdown links to other files it is including in the documentation and rewrite them accordingly."},"comment":{"url":"https://api.github.com/repos/lsegal/yard/issues/comments/100539396","html_url":"https://github.com/lsegal/yard/issues/863#issuecomment-100539396","issue_url":"https://api.github.com/repos/lsegal/yard/issues/863","id":100539396,"user":{"login":"mvz","id":10898,"avatar_url":"https://avatars.githubusercontent.com/u/10898?v=3","gravatar_id":"","url":"https://api.github.com/users/mvz","html_url":"https://github.com/mvz","followers_url":"https://api.github.com/users/mvz/followers","following_url":"https://api.github.com/users/mvz/following{/other_user}","gists_url":"https://api.github.com/users/mvz/gists{/gist_id}","starred_url":"https://api.github.com/users/mvz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mvz/subscriptions","organizations_url":"https://api.github.com/users/mvz/orgs","repos_url":"https://api.github.com/users/mvz/repos","events_url":"https://api.github.com/users/mvz/events{/privacy}","received_events_url":"https://api.github.com/users/mvz/received_events","type":"User","site_admin":false},"created_at":"2015-05-09T20:03:41Z","updated_at":"2015-05-09T20:03:41Z","body":"Hi @lsegal, I went with your option 2 and made a small plugin just for our specific case. See https://github.com/troessner/reek/blob/87b0e75091552c59fcf20105016ba6ce97a57b06/docs/yard_plugin.rb\r\n\r\nThanks!"}}