{"id":13725184,"url":"https://github.com/taehwanno/react-github-renderer","last_synced_at":"2025-05-07T16:11:28.150Z","repository":{"id":88089137,"uuid":"112071673","full_name":"taehwanno/react-github-renderer","owner":"taehwanno","description":":octocat: A react custom renderer for Github","archived":false,"fork":false,"pushed_at":"2017-11-28T15:50:23.000Z","size":115,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-07T16:11:25.181Z","etag":null,"topics":["custom-renderer","react","react-renderer"],"latest_commit_sha":null,"homepage":"https://npm.im/react-github-renderer","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/taehwanno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2017-11-26T09:49:23.000Z","updated_at":"2023-03-04T05:29:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"aa25f099-8d18-4c58-b188-db09527a3796","html_url":"https://github.com/taehwanno/react-github-renderer","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"f63670699e91fd3b1766af4f0cc1f6f05927e8a0"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taehwanno%2Freact-github-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taehwanno%2Freact-github-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taehwanno%2Freact-github-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taehwanno%2Freact-github-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taehwanno","download_url":"https://codeload.github.com/taehwanno/react-github-renderer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252912996,"owners_count":21824066,"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":["custom-renderer","react","react-renderer"],"created_at":"2024-08-03T01:02:15.217Z","updated_at":"2025-05-07T16:11:28.099Z","avatar_url":"https://github.com/taehwanno.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# react-github-renderer [![Build Status](https://circleci.com/gh/taehwanno/react-github-renderer/tree/master.svg?style=shield\u0026circle-token=08557fea8367bfc1b2a1d8b72a87eaad9dd12b67)](https://circleci.com/gh/taehwanno/react-github-renderer/tree/master) [![npm version](https://badge.fury.io/js/react-github-renderer.svg)](https://badge.fury.io/js/react-github-renderer)\n\n\u003e A react custom renderer for Github :octocat:\n\n**Table of contents**\n\n- [Installation](#installation)\n- [Motivation](#motivation)\n- [API](#api)\n  - [Renderer](#renderer)\n    - `ReactGithub.render(element)`\n  - [Components](#components)\n    - [Gists](#gists)\n      - `\u003cGist description isPublic children /\u003e`\n      - `\u003cFile name children /\u003e`\n    - [Releases](#releases)\n      - `\u003cRelease tagName targetCommitish name draft prerelease children /\u003e`\n- [Examples](#examples)\n\n# Installation\n\n```bash\n$ npm install --save react-github-renderer\n```\n\nAlternatively, using yarn.\n\n```bash\n$ yarn add react-github-renderer\n```\n\n# Motivation\n\nJust for fun. I have wanted to look into react implementation (renderer, reconciler).\n\n# API\n\n## Renderer\n\n- `ReactGithub.render(element)`\n\n## Components\n\n- ### Gists\n\n```jsx\n\u003cGist description isPublic\u003e\n  \u003cFile name children /\u003e\n\u003c/Gist\u003e\n```\n\n```jsx\n\u003cGist description isPublic children /\u003e\n```\n\n- `description` (*String*): a description of the gist (Default: `''`)\n- `isPublic` (*Boolean*): indicates whether the gist is public. (Default: `false`)\n\n```jsx\n\u003cFile name children /\u003e\n```\n\n- `name` (*String*, **Required**): name of file\n- `children` (*String*, **Required**): contents of file\n\n- ### Releases\n\n```jsx\n\u003cRelease tagName targetCommitish name draft prerelease children /\u003e\n```\n\n- `tagName` (*String*, **Required**): the name of the tag\n- `targetCommitish` (*String*): the commitish value that determines where the Git tag is created from (Default: `master`)\n- `name` (*String*): the name of the release\n- `draft` (*Boolean*): `true` to create a draft (unpublished) release, `false` to create a published one. (Default: `false`)\n- `prerelease` (*Boolean*): `true` to identify the release as a prerelease. `false` to identify the release as a full release. (Default: `false`)\n- `children` (*String*): text describing the contents of the tag\n\n# Examples\n\n- ## [Gists](./examples/Gists/README.md)\n\n```jsx\nimport React from 'react';\nimport ReactGithub, { Gist, File } from 'react-github-renderer';\nimport GithubClient from './GithubClient';\n\nconst gist = ReactGithub.render(\n  \u003cGist description=\"gist created by react-github-renderer\" isPublic={false}\u003e\n    \u003cFile name=\"file.js\"\u003e\n      function fn() {}\n    \u003c/File\u003e\n    \u003cFile name=\"file2.txt\"\u003e\n      contents of file2.txt\n    \u003c/File\u003e\n  \u003c/Gist\u003e\n);\n\nGithubClient.createGist(gist);\n```\n\n- ## [Releases](./examples/Releases/README.md)\n\n```jsx\nimport React from 'react';\nimport ReactGithub, { Release } from 'react-github-renderer';\nimport GithubClient from './GithubClient';\n\nconst release = ReactGithub.render(\n  \u003cRelease\n    tagName=\"v1.0.0\"\n    targetCommitish=\"master\"\n    name=\"v1.0.0\"\n    draft\n    prerelease={false}\n  \u003e\n    - Update dependencies version (#15)\n  \u003c/Release\u003e\n);\n\nGithubClient.createRelease(release);\n```\n\n# Thanks\n\n- [@nitin42](https://github.com/nitin42): for [helpful tutorial](https://github.com/nitin42/Making-a-custom-React-renderer)\n- [@iamdustan](https://github.com/iamdustan): for [tiny-react-renderer](https://github.com/iamdustan/tiny-react-renderer) with a brief implementation\n- [@CentaurWarchief](https://github.com/CentaurWarchief): for inspiration from [react-slack-renderer](https://github.com/CentaurWarchief/react-slack-renderer)\n\n# License\n\nMIT © [Taehwan, No (taehwanno)](https://github.com/taehwanno)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaehwanno%2Freact-github-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaehwanno%2Freact-github-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaehwanno%2Freact-github-renderer/lists"}