{"id":17329631,"url":"https://github.com/haines/yard-relative_markdown_links","last_synced_at":"2025-04-14T16:33:08.511Z","repository":{"id":32555245,"uuid":"136890809","full_name":"haines/yard-relative_markdown_links","owner":"haines","description":"A YARD plugin to allow relative links between Markdown files.","archived":false,"fork":false,"pushed_at":"2024-10-29T22:16:02.000Z","size":432,"stargazers_count":11,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-30T00:42:42.601Z","etag":null,"topics":["documentation","markdown","ruby","yard","yard-plugin"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haines.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-11T07:36:33.000Z","updated_at":"2024-10-29T22:16:05.000Z","dependencies_parsed_at":"2024-03-02T01:30:59.333Z","dependency_job_id":"97636262-3863-4666-8876-182d0caea151","html_url":"https://github.com/haines/yard-relative_markdown_links","commit_stats":{"total_commits":161,"total_committers":4,"mean_commits":40.25,"dds":0.2981366459627329,"last_synced_commit":"bb94ad73e610c8c6d7f8070d85c065a587210de9"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haines%2Fyard-relative_markdown_links","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haines%2Fyard-relative_markdown_links/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haines%2Fyard-relative_markdown_links/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haines%2Fyard-relative_markdown_links/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haines","download_url":"https://codeload.github.com/haines/yard-relative_markdown_links/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223639403,"owners_count":17177816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","markdown","ruby","yard","yard-plugin"],"created_at":"2024-10-15T14:49:00.218Z","updated_at":"2024-11-08T06:01:33.973Z","avatar_url":"https://github.com/haines.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YARD::RelativeMarkdownLinks\n\n[![Docs](https://img.shields.io/badge/docs-github.io-blue.svg?style=flat-square)](https://haines.github.io/yard-relative_markdown_links/)\n[![Gem](https://img.shields.io/gem/v/yard-relative_markdown_links.svg?style=flat-square)](https://rubygems.org/gems/yard-relative_markdown_links)\n[![GitHub](https://img.shields.io/badge/github-haines%2Fyard--relative__markdown__links-blue.svg?style=flat-square)](https://github.com/haines/yard-relative_markdown_links)\n[![License](https://img.shields.io/github/license/haines/yard-relative_markdown_links.svg?style=flat-square)](https://github.com/haines/yard-relative_markdown_links/blob/main/LICENSE.md)\n\n\nA [YARD](https://yardoc.org) plugin to allow relative links between Markdown files.\n\nGitHub and YARD render Markdown files differently.\nIn particular, relative links in Markdown files that work in GitHub don't work in YARD.\nFor example, if you have `[hello](FOO.md)` in your README, YARD renders it as `\u003ca href=\"FOO.md\"\u003ehello\u003c/a\u003e`, creating a broken link in your docs.\n\nWith this plugin enabled, you'll get `\u003ca href=\"file.FOO.html\"\u003ehello\u003c/a\u003e` instead, which correctly links through to the rendered HTML file.\n\n\n## Installation\n\nAdd this line to your application's `Gemfile`:\n\n```ruby\ngem \"yard-relative_markdown_links\"\n```\n\nAnd then execute:\n\n```console\n$ bundle install\n```\n\nOr install it yourself as:\n\n```console\n$ gem install yard-relative_markdown_links\n```\n\n\n## Usage\n\nAdd this line to your application's `.yardopts`:\n\n```\n--plugin relative_markdown_links\n```\n\nYou'll also need to make sure your Markdown files are processed by YARD.\nTo include all Markdown files in your project, add the following lines to the end of your application's `.yardopts`:\n\n```\n-\n**/*.md\n```\n\nIf you include other types of file, relative links to those files from Markdown will work as well.\n\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies.\nThen, run `bin/rake test` to run the tests.\nYou can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bin/rake install`.\nTo release a new version, update the version number in `lib/yard/relative_markdown_links/version.rb`, and then run `bin/rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [RubyGems](https://rubygems.org).\n\n\n## Contributing\n\nBug reports and pull requests are welcome [on GitHub](https://github.com/haines/yard-relative_markdown_links).\nThis project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).\n\n\n## License\n\n© 2018 Andrew Haines, released under the [MIT license](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaines%2Fyard-relative_markdown_links","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaines%2Fyard-relative_markdown_links","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaines%2Fyard-relative_markdown_links/lists"}