{"id":22981040,"url":"https://github.com/rubyworks/yard-tomdoc","last_synced_at":"2025-08-13T17:33:47.205Z","repository":{"id":1451991,"uuid":"1685157","full_name":"rubyworks/yard-tomdoc","owner":"rubyworks","description":"Implements TomDoc syntax markup for YARD","archived":false,"fork":false,"pushed_at":"2014-08-15T15:45:32.000Z","size":567,"stargazers_count":31,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-06-27T15:07:46.284Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://rubyworks.github.com/yard-tomdoc","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/rubyworks.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-04-30T16:16:09.000Z","updated_at":"2023-05-18T08:12:44.000Z","dependencies_parsed_at":"2022-07-15T10:30:44.804Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/yard-tomdoc","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-tomdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-tomdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-tomdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-tomdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/yard-tomdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229773540,"owners_count":18122031,"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":[],"created_at":"2024-12-15T01:46:49.578Z","updated_at":"2024-12-15T01:46:50.171Z","avatar_url":"https://github.com/rubyworks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YARD TomDoc\n\n[Website](http://rubyworks.github.com/yard-tomdoc) /\n[Documentation](http://rubydoc.info/gems/yard-tomdoc/frames) /\n[Issues](http://github.com/rubyworks/yard-tomdoc/issues) /\n[Source Code](http://github.com/rubyworks/yard-tomdoc)\n\n[![Gem Version](https://badge.fury.io/rb/yard-tomdoc.png)](http://badge.fury.io/rb/yard-tomdoc)\n[![Build Status](https://secure.travis-ci.org/rubyworks/yard-tomdoc.png)](http://travis-ci.org/rubyworks/yard-tomdoc) \u0026nbsp; \u0026nbsp;\n[![Flattr Me](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)\n\n\n## Description\n\nImplements [TomDoc](http://tomdoc.org) syntax for YARD. 'Nuff said.\n\n\n## Instruction\n\nSince `yard-tomdoc` is a standard YARD plugin, utilize it with yard's\n`--plugin` option.\n\n    $ yard --plugin tomdoc [...]\n\n\n## Limitations\n\nBefore you use yard-tomdoc you should read [Loren Segal's blog post](http://gnuu.org/2010/05/12/whats-missing-from-tomdoc/)\nabout the differences between YARD and TomDoc syntax. But note that the YARD\nTomDoc plugin now supports a superset of TomDoc's syntax which provides additional\nYARD functionality via *cap-tags*. For example using `Author: James Deam` in the\ndocumentation is equivalent to using `@author James Dean` in regular YARD syntax.\nSupport is limited, but it opens up much more of YARD's goodness to TomDoc\nusers then Loren's blog post suggests.\n\n\n## Acknowledgements\n\nHuge thanks to Loren Segal, the creator of YARD and the original author of this\nplugin. Without his patient assistance and coding genius, this library would not\nhave been possible.\n\n\n## Licensing\n\nYARD TomDoc is copyrighted open-source software.\n\nCopyright (c) 2010 Rubyworks. All rights reserved.\n\nYARD TomDoc can be modified and redistributed in accordance with the terms\nof the **MIT** licsnse.\n\nSee the `LICENSE.txt` file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fyard-tomdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Fyard-tomdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fyard-tomdoc/lists"}