https://github.com/axelmy318/react-readme-printer

Provides a function to load a readme file from github repositories and a React component to convert markdown to jsx
https://github.com/axelmy318/react-readme-printer

github github-api loader markdown nodejs npm package react reactjs readme

Last synced: about 2 months ago
JSON representation

Provides a function to load a readme file from github repositories and a React component to convert markdown to jsx

• Host: GitHub
• URL: https://github.com/axelmy318/react-readme-printer
• Owner: axelmy318
• Created: 2022-01-24T10:33:31.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-13T14:29:43.000Z (almost 2 years ago)
• Last Synced: 2024-08-10T11:24:08.444Z (5 months ago)
• Topics: github, github-api, loader, markdown, nodejs, npm, package, react, reactjs, readme
• Language: CSS
• Homepage:
• Size: 789 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# react-readme-printer 👋

Provides a function to load a readme file from github repositories and a React component to automatically load and convert markdown to jsx

## Installation 

`npm i react-readme-printer`

## Demo 👀

[https://axelmry.com/react-readme-printer](https://axelmry.com/react-readme-printer) (...with code 😉)

## Usage 💻

```javascript

import React from 'react'

import { MarkdownPrinter } from 'react-readme-printer'

const Example = () => {

    return (

        

    )

    

}

export default Example

```

## Dependencies

This project relies on [react-markdown](https://www.npmjs.com/package/react-markdown) to convert the markdown files to JSX

## API ✔

| Properties | type | default | description |

|--|--|--|--|

| username | string | null | The GitHub username |

| repository | string | null | The GitHub repository from which to fetch the README.md |

| branch | string | "main" | The branch on which to fetch the README.md |

| file | string | "README" | The filename of the readme file. The `.md` is automatically added |

| showRepository | bool | true | Wether to show the repository name or not. See examples |

| markdownConfig | object | {} | The props to pass down to the ReactMarkdown component |

| convertHtmlImgToMarkdown | bool | false | Wether to convert `