{"id":21648010,"url":"https://github.com/atom-community/atom-ide-markdown-service","last_synced_at":"2025-04-11T19:33:08.781Z","repository":{"id":37030132,"uuid":"176094077","full_name":"atom-community/atom-ide-markdown-service","owner":"atom-community","description":"A service component offering markdown rendering","archived":false,"fork":false,"pushed_at":"2023-10-16T21:20:19.000Z","size":1118,"stargazers_count":11,"open_issues_count":16,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T15:22:00.983Z","etag":null,"topics":["atom","atom-package","hacktoberfest","markdown","provider"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atom-community.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"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":"2019-03-17T11:53:56.000Z","updated_at":"2022-11-21T03:27:57.000Z","dependencies_parsed_at":"2024-06-19T05:23:05.325Z","dependency_job_id":"c57bebef-9a84-4342-bb69-7c10e001ad9f","html_url":"https://github.com/atom-community/atom-ide-markdown-service","commit_stats":{"total_commits":156,"total_committers":6,"mean_commits":26.0,"dds":0.2948717948717948,"last_synced_commit":"608eda849cc20dfcf2d04227492e9275bfc44da4"},"previous_names":["atom-ide-community/atom-ide-markdown-service"],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atom-community%2Fatom-ide-markdown-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atom-community%2Fatom-ide-markdown-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atom-community%2Fatom-ide-markdown-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atom-community%2Fatom-ide-markdown-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atom-community","download_url":"https://codeload.github.com/atom-community/atom-ide-markdown-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248467223,"owners_count":21108610,"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":["atom","atom-package","hacktoberfest","markdown","provider"],"created_at":"2024-11-25T06:52:52.929Z","updated_at":"2025-04-11T19:33:08.748Z","avatar_url":"https://github.com/atom-community.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# atom-ide-markdown-service package\n\nMarkdown service in atom-ide-community packages (e.g. ide-datatip).\n\n### Usage\n\nJust install.\n\n### Developer Usage - As apm package\n\nPut this in your `package.json`\n\n```json\n\"consumedServices\": {\n  \"markdown-renderer\": {\n    \"versions\": {\n      \"1.0.0\": \"consumeMarkdownRenderer\"\n    }\n  }\n}\n```\n\nand use it inside your package like this:\n\n```js\nimport type {MarkdownService} from \"atom-ide-base\"\n\nlet render: MarkdownService[\"render\"]\n\n/**\n * retrieves a reference to the markdown rendering service that should be used\n * @param  {MarkdownService} markdownService the service for rendering markdown text\n */\nexport function consumeMarkdownRenderer(markdownService: MarkdownService) {\n  render = markdownService.render\n}\n```\n\n`render` is a function with this type:\n\n```js\nlet render: (markdownText: string, grammar: string) =\u003e Promise\u003cstring\u003e\n```\n\n### Developer Usage - as npm package - ES6 modules\n\n```\nnpm install --save atom-ide-markdown-service\n```\n\nand use it inside your package like this:\n\n```js\nimport { render } from \"atom-ide-markdown-service/modules/renderer\"\n```\n\nin which renderer is a function with this type `render(markdownText: string, grammar: string) =\u003e Promise\u003cstring\u003e`\n\n### Developer Usage - as npm package - commonjs\n\n```\nnpm install --save atom-ide-markdown-service\n```\n\nand use it inside your package like this:\n\n```js\nconst { render } = require(\"atom-ide-markdown-service/dist/renderer\")\n```\n\nin which render is a function with this type `renderer(markdownText: string, grammar: string) =\u003e Promise\u003cstring\u003e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatom-community%2Fatom-ide-markdown-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatom-community%2Fatom-ide-markdown-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatom-community%2Fatom-ide-markdown-service/lists"}