{"id":13696994,"url":"https://github.com/open-rpc/docs-react","last_synced_at":"2025-10-19T03:20:00.043Z","repository":{"id":48272685,"uuid":"176998277","full_name":"open-rpc/docs-react","owner":"open-rpc","description":"OpenRPC documentation as a react component.","archived":false,"fork":false,"pushed_at":"2021-08-03T19:20:36.000Z","size":2185,"stargazers_count":10,"open_issues_count":35,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T16:12:35.952Z","etag":null,"topics":["docs-react","openrpc-documentation"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/open-rpc.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}},"created_at":"2019-03-21T18:00:07.000Z","updated_at":"2024-11-03T15:43:56.000Z","dependencies_parsed_at":"2022-08-23T15:21:11.841Z","dependency_job_id":null,"html_url":"https://github.com/open-rpc/docs-react","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-rpc%2Fdocs-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-rpc%2Fdocs-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-rpc%2Fdocs-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-rpc%2Fdocs-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-rpc","download_url":"https://codeload.github.com/open-rpc/docs-react/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065282,"owners_count":21041872,"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":["docs-react","openrpc-documentation"],"created_at":"2024-08-02T18:00:51.173Z","updated_at":"2025-10-19T03:19:54.989Z","avatar_url":"https://github.com/open-rpc.png","language":"TypeScript","funding_links":[],"categories":["Tools"],"sub_categories":["Interface Description"],"readme":"# docs-react\nOpenRPC documentation as a react component\n\n#### What is this?\nThis is a react component that will render documentation for a given OpenRPC document.\n\n**Screenshot**:\n\n![image](https://user-images.githubusercontent.com/364566/54795109-1b1f5b80-4c08-11e9-9ba9-cc2f2d96c692.png)\n\n\n#### How do I use this?\n\n##### Installation:\n```\nnpm install --save @open-rpc/docs-react\n```\n##### Usage:\n```\nimport Documentation from \"@open-rpc/docs-react\";\n```\nand then use it somewhere:\n\n```\n\u003cDocumentation schema={schema} /\u003e\n```\n\n##### Example in a new project:\n\n###### create a new typescript project with `create-react-app`\n\n```\nnpx create-react-app \u003cappname\u003e --typescript\n```\n\n```\ncd \u003cappname\u003e\nnpm install .\nnpm install @open-rpc/docs-react @open-rpc/meta-schema --save\n```\n\n###### index.ts\n```\nimport React from 'react';\nimport ReactDOM from 'react-dom';\nimport Documentation from \"@open-rpc/docs-react\";\nimport { OpenrpcDocument } from '@open-rpc/meta-schema';\n\nconst schema: OpenrpcDocument = {\n  openrpc: \"1.2.4\",\n  info: {\n    \"version\": \"0.0.0-development\",\n    \"title\": \"My New API\"\n  },\n  methods: []\n};\n\nReactDOM.render(\u003cDocumentation schema={schema} /\u003e, document.getElementById(\"root\"));\n\n```\n\n###### screenshot\n![image](https://user-images.githubusercontent.com/364566/54797953-920e2180-4c13-11e9-9ff8-723a836d0e2c.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-rpc%2Fdocs-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-rpc%2Fdocs-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-rpc%2Fdocs-react/lists"}