{"id":26376326,"url":"https://github.com/metadoc/metadoc-plugin","last_synced_at":"2025-03-17T03:16:57.505Z","repository":{"id":48031026,"uuid":"146635169","full_name":"metadoc/metadoc-plugin","owner":"metadoc","description":"An extendable base class for building metadoc plugins.","archived":false,"fork":false,"pushed_at":"2022-12-07T23:54:05.000Z","size":244,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T11:42:06.320Z","etag":null,"topics":["documentation","generator","javascript","metadoc"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/metadoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["coreybutler"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-08-29T17:29:21.000Z","updated_at":"2021-12-18T18:26:20.000Z","dependencies_parsed_at":"2023-01-25T00:31:29.795Z","dependency_job_id":null,"html_url":"https://github.com/metadoc/metadoc-plugin","commit_stats":null,"previous_names":["author/metadoc-plugin-base"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metadoc%2Fmetadoc-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metadoc%2Fmetadoc-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metadoc%2Fmetadoc-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metadoc%2Fmetadoc-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metadoc","download_url":"https://codeload.github.com/metadoc/metadoc-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243776733,"owners_count":20346354,"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","generator","javascript","metadoc"],"created_at":"2025-03-17T03:16:56.812Z","updated_at":"2025-03-17T03:16:57.495Z","avatar_url":"https://github.com/metadoc.png","language":"JavaScript","funding_links":["https://github.com/sponsors/coreybutler"],"categories":[],"sub_categories":[],"readme":"# metadoc-plugin\n\nAn extendable base class for building metadoc plugins.\n\n## Usage\n\n`npm install @author.io/metadoc-plugin -D`\n\n_An example plugin:_\n\n```js\nconst MetadocPlugin = require('@author.io/metadoc-plugin')\n\nclass MyPlugin extends MetadocPlugin {\n  constructor () {\n    super(...arguments)\n  }\n\n  process () {\n    console.log('Do something with', this.data)\n  }\n}\n```\n\nThe metadoc plugin base class is en extension of the Node.js [EventEmitter](https://nodejs.org/docs/latest/api/events.html#events_class_eventemitter) class, meaning it can fire events.\n\nIt's a pretty simplistic class, so it might be easier to just **read the code**.\n\nThe key elements are the `source` and `output` attributs and the helper methods.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetadoc%2Fmetadoc-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetadoc%2Fmetadoc-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetadoc%2Fmetadoc-plugin/lists"}