{"id":15391931,"url":"https://github.com/scrum/awesome-readme-to-data","last_synced_at":"2026-02-06T10:37:22.771Z","repository":{"id":40288404,"uuid":"249955945","full_name":"Scrum/awesome-readme-to-data","owner":"Scrum","description":"Transform awesome readme to data","archived":false,"fork":false,"pushed_at":"2023-01-05T17:05:49.000Z","size":606,"stargazers_count":1,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-05T20:01:24.409Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Scrum.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":".github/funding.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":"scrums","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-03-25T11:06:05.000Z","updated_at":"2023-09-08T18:05:01.000Z","dependencies_parsed_at":"2023-02-04T08:15:56.698Z","dependency_job_id":null,"html_url":"https://github.com/Scrum/awesome-readme-to-data","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Scrum/awesome-readme-to-data","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scrum%2Fawesome-readme-to-data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scrum%2Fawesome-readme-to-data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scrum%2Fawesome-readme-to-data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scrum%2Fawesome-readme-to-data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Scrum","download_url":"https://codeload.github.com/Scrum/awesome-readme-to-data/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scrum%2Fawesome-readme-to-data/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29158107,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T07:18:23.844Z","status":"ssl_error","status_checked_at":"2026-02-06T07:13:32.659Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-10-01T15:13:31.998Z","updated_at":"2026-02-06T10:37:22.752Z","avatar_url":"https://github.com/Scrum.png","language":"JavaScript","funding_links":["https://patreon.com/scrums"],"categories":[],"sub_categories":[],"readme":"# \u003cimg valign=\"text-bottom\" height=\"49\" src=\"assets/logo.svg\" align=\"right\"\u003e awesome-readme-to-data\n\u003e Transform awesome readme to data\n\n[![Actions Status](https://github.com/Scrum/vue-2-breadcrumbs/workflows/Actions%20Status/badge.svg?style=flat-square)](https://github.com/Scrum/vue-2-breadcrumbs/actions?query=workflow%3A%22CI+tests%22)[![node](https://img.shields.io/node/v/awesome-readme-to-data.svg?style=flat-square)]()[![npm version](https://img.shields.io/npm/v/awesome-readme-to-data.svg?style=flat-square)](https://www.npmjs.com/package/awesome-readme-to-data)[![Dependency Status](https://david-dm.org/Scrum/awesome-readme-to-data.svg?style=flat-square)](https://david-dm.org/Scrum/awesome-readme-to-data)[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg?style=flat-square)](https://github.com/xojs/xo)[![Coveralls status](https://img.shields.io/coveralls/Scrum/awesome-readme-to-data.svg?style=flat-square)](https://coveralls.io/r/Scrum/awesome-readme-to-data)\n\n[![npm downloads](https://img.shields.io/npm/dm/awesome-readme-to-data.svg?style=flat-square)](https://www.npmjs.com/package/awesome-readme-to-data)[![npm](https://img.shields.io/npm/dt/awesome-readme-to-data.svg?style=flat-square)](https://www.npmjs.com/package/awesome-readme-to-data)[![Package Quality](http://npm.packagequality.com/shield/awesome-readme-to-data.svg?style=flat-square)](http://packagequality.com/#?package=awesome-readme-to-data)\n\n## Why?\nRequired to create data from awesome readme files\n\n## Install\n\n```bash\n$ npm install awesome-readme-to-data\n```\n\n\u003e **Note:** This project is compatible with node v10+\n\n## Usage\n\n```js\nconst awesomeReadmeToData = require('awesome-readme-to-data');\nconst md = `\n# awesome you project\n\u003c!-- md-parser-start --\u003e\n## Level 1\n\n### Level 1.1\n\n*Description leve 1.1*\n\n- [text link 1](https://url-link-1) - A description link 1\n- [text link 2](https://url-link-2) - A description link 2\n\u003c!-- md-parser-end --\u003e\n`;\n\nawesomeReadmeToData(md, options)\n  .then(data =\u003e {\n    console.log(data);\n  });\n```\n\n# Example\n\n```md\n/* readme.md */\n# awesome you project\n\u003c!-- md-parser-start --\u003e\n## Level 1\n\n### Level 1.1\n\n*Description leve 1.1*\n\n- [text link 1](https://url-link-1) - A description link 1\n- [text link 2](https://url-link-2) - A description link 2\n\n### Level 1.2\n\n*Description leve 1.1*\n\n- [text link 1](https://url-link-1)\n- [text link 2](https://url-link-2)\n\u003c!-- md-parser-end --\u003e\n```\n\n```js\n/* output-data.js */\n[\n  {\n    name: 'Level 1',\n    children: [{\n      name: 'Level 1.1',\n      children: [{\n        name: 'text link 1',\n        path: 'https://url-link-1',\n        description: 'A description link 1'\n      },{\n        name: 'text link 2',\n        path: 'https://url-link-2',\n        description: 'A description link 2'\n      }]\n    },{\n      name: 'Level 1.2',\n      description: '*Description leve 1.2*',\n      children: [{\n        name: 'text link 1',\n        path: 'https://url-link-1'\n      },{\n        name: 'text link 2',\n        path: 'https://url-link-2'\n      }]\n    }]\n  }\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrum%2Fawesome-readme-to-data","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrum%2Fawesome-readme-to-data","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrum%2Fawesome-readme-to-data/lists"}