{"id":21088139,"url":"https://github.com/axelmy318/react-readme-printer","last_synced_at":"2026-04-12T15:04:12.475Z","repository":{"id":57343099,"uuid":"451419758","full_name":"axelmy318/react-readme-printer","owner":"axelmy318","description":"Provides a function to load a readme file from github repositories and a React component to convert markdown to jsx","archived":false,"fork":false,"pushed_at":"2023-02-13T14:29:43.000Z","size":808,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-21T00:40:58.406Z","etag":null,"topics":["github","github-api","loader","markdown","nodejs","npm","package","react","reactjs","readme"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/axelmy318.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2022-01-24T10:33:31.000Z","updated_at":"2023-05-19T09:15:38.000Z","dependencies_parsed_at":"2025-01-21T00:31:54.710Z","dependency_job_id":"c4825321-52b7-4021-af62-f3d322ac04a1","html_url":"https://github.com/axelmy318/react-readme-printer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelmy318%2Freact-readme-printer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelmy318%2Freact-readme-printer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelmy318%2Freact-readme-printer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axelmy318%2Freact-readme-printer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/axelmy318","download_url":"https://codeload.github.com/axelmy318/react-readme-printer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243532532,"owners_count":20306152,"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":["github","github-api","loader","markdown","nodejs","npm","package","react","reactjs","readme"],"created_at":"2024-11-19T21:15:32.412Z","updated_at":"2025-12-29T15:33:47.282Z","avatar_url":"https://github.com/axelmy318.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-readme-printer 👋\nProvides a function to load a readme file from github repositories and a React component to automatically load and convert markdown to jsx\n\n\n## Installation \n`npm i react-readme-printer`\n\n\n## Demo 👀\n\n[https://axelmry.com/react-readme-printer](https://axelmry.com/react-readme-printer) (...with code 😉)\n\n\n## Usage 💻\n\n```javascript\nimport React from 'react'\nimport { MarkdownPrinter } from 'react-readme-printer'\n\nconst Example = () =\u003e {\n    return (\n        \u003cMarkdownPrinter\n            username='axelmy318'\n            repository='react-readme-printer'\n            branch='master'\n            file='custom_readme_name'\n        /\u003e\n    )\n    \n}\n\nexport default Example\n```\n\n\n## Dependencies\n\nThis project relies on [react-markdown](https://www.npmjs.com/package/react-markdown) to convert the markdown files to JSX\n\n\n## API ✔\n\n| Properties | type | default | description |\n|--|--|--|--|\n| username | string | null | The GitHub username |\n| repository | string | null | The GitHub repository from which to fetch the README.md |\n| branch | string | \"main\" | The branch on which to fetch the README.md |\n| file | string | \"README\" | The filename of the readme file. The `.md` is automatically added |\n| showRepository | bool | true | Wether to show the repository name or not. See examples |\n| markdownConfig | object | {} | The props to pass down to the ReactMarkdown component |\n| convertHtmlImgToMarkdown | bool | false | Wether to convert `\u003cimg src='foo_bar\u003e` tags into ![](foo_bar) or not |","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxelmy318%2Freact-readme-printer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faxelmy318%2Freact-readme-printer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxelmy318%2Freact-readme-printer/lists"}