{"id":20221067,"url":"https://github.com/christoph-jerolimov/react-native-showdown","last_synced_at":"2025-06-24T04:06:55.468Z","repository":{"id":55666388,"uuid":"48890181","full_name":"christoph-jerolimov/react-native-showdown","owner":"christoph-jerolimov","description":"React-native component which renders markdown into a webview!","archived":false,"fork":false,"pushed_at":"2020-12-14T09:24:31.000Z","size":483,"stargazers_count":50,"open_issues_count":0,"forks_count":19,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-18T20:59:27.590Z","etag":null,"topics":["android","ios","markdown","react-component","react-native","react-native-webview","showdown","webview"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/christoph-jerolimov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-01T21:39:49.000Z","updated_at":"2024-09-01T18:57:40.000Z","dependencies_parsed_at":"2022-08-15T06:00:41.422Z","dependency_job_id":null,"html_url":"https://github.com/christoph-jerolimov/react-native-showdown","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/christoph-jerolimov/react-native-showdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christoph-jerolimov%2Freact-native-showdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christoph-jerolimov%2Freact-native-showdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christoph-jerolimov%2Freact-native-showdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christoph-jerolimov%2Freact-native-showdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christoph-jerolimov","download_url":"https://codeload.github.com/christoph-jerolimov/react-native-showdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christoph-jerolimov%2Freact-native-showdown/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261601483,"owners_count":23183093,"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":["android","ios","markdown","react-component","react-native","react-native-webview","showdown","webview"],"created_at":"2024-11-14T06:51:10.459Z","updated_at":"2025-06-24T04:06:55.439Z","avatar_url":"https://github.com/christoph-jerolimov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-native-showdown [![Dependency Status][dependency-image]][dependency-url]\n\n[React-native](http://facebook.github.io/react-native/) component which renders markdown into a webview!\n\nSince version 1.0.0 it requires the peer dependency [react-native-webview](https://github.com/react-native-community/react-native-webview).\n\n## Features\n\n* Renders Markdown into a React Native WebView component.\n* Pure JavaScript implementation, based on [Showdown](https://github.com/showdownjs/showdown),\n  extendable with all (?) [Showdown Extensions](https://github.com/showdownjs/showdown/wiki/Extensions).\n* No native code / No react-native link required.\n* Customizable with CSS.\n* Full TypeScript Support.\n* Fully tested. 100% Code Coverage.\n* ~~Automatically opens links in the system browser.~~ Supports all React Native WebView props and callbacks!\n\n## Installation\n\n```bash\nnpm install --save react-native-showdown react-native-webview\n```\n\nor\n\n```bash\nyarn add react-native-showdown react-native-webview\n```\n\nWith expo you are done.\n\nWith a pure React Native project you need to link react-native-webview:\n\n```bash\nreact-native link react-native-webview\ncd pods \u0026\u0026 pod install \u0026\u0026 cd ..\n```\n\n## Usage\n\nFull ES6 / TypeScript example:\n\n```jsx\nimport React from 'react';\nimport Markdown from 'react-native-showdown';\nimport { SafeAreaView } from 'react-native';\n\nexport default function App() {\n  const markdown = `\n# Welcome to React Native Showdown!\n\nTo get started, edit the markdown in \\`App.tsx\\`.\n\n| Column 1 | Column 2 |\n|----------|----------|\n| A1       | B1       |\n| A2       | B2       |\n`;\n\n  const css = `\nh1 { color: red; }\ncode { font-size: 1.2rem; background-color: lightgray; }\n`;\n\n  return (\n    \u003cSafeAreaView style={{ flex: 1 }}\u003e\n      \u003cMarkdown markdown={markdown} css={css} /\u003e\n    \u003c/SafeAreaView\u003e\n  );\n}\n```\n\n## Available props / converter options\n\n* `markdown` String, required;\n  Markdown string which will be shown as webview content.\n  (Previous prop `body` is also still supported as fallback.)\n* `css` String, optional;\n  CSS which will be used to style the webview content.\n  (Previous prop `pureCSS` is also still supported as fallback.)\n* `title` String, optional;\n  Sets the HTML title tag.\n* `options` ConverterOptions, optional;\n  All [Showdown#options](https://github.com/showdownjs/showdown#valid-options). \n  Default is `{simplifiedAutoLink: true, strikethrough: true, tables: true}`.\n* All other [react-native-webview](https://github.com/react-native-community/react-native-webview)\n  [props](https://github.com/react-native-community/react-native-webview/blob/master/docs/Reference.md#props-index) and callbacks are also supported, expect the `source` prop!\n* Notice that the WebView has a default `{ flex: 1 }` style defined.\n\n## Run the example\n\n```bash\ngit clone https://github.com/jerolimov/react-native-showdown.git\ncd react-native-showdown\nyarn install\nyarn bootstrap   # which is similar to   cd example \u0026\u0026 yarn install\n\ncd example\nyarn ios         # or\nyarn android\n```\n\n## Credits\n\nProject is based on the markdown parser [Showdown](https://github.com/showdownjs/showdown).\n\nProject build setup created with [@react-native-community/bob](https://github.com/react-native-community/bob)\n\n## License\n\nMIT License\n\nCopyright (c) 2016-2020 Christoph Jerolimov\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n## Alternatives\n\nLibraries that renders Markdown as native components instead of using a WebView:\n\n* [react-native-render-html](https://github.com/archriss/react-native-render-html)\n* [react-native-markdown](https://github.com/lwansbrough/react-native-markdown)\n* [react-native-htmlview](https://github.com/jsdf/react-native-htmlview)\n\n[dependency-image]: http://img.shields.io/david/jerolimov/react-native-showdown.svg?style=flat-square\n[dependency-url]: https://david-dm.org/jerolimov/react-native-showdown\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristoph-jerolimov%2Freact-native-showdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristoph-jerolimov%2Freact-native-showdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristoph-jerolimov%2Freact-native-showdown/lists"}