react-devdotto
Version:
> Embed your Posts on Dev.to into your React Project.
70 lines (50 loc) • 2.24 kB
Markdown
# react-devdotto
> Embed your Posts on Dev.to into your React Project.
[](https://www.npmjs.com/package/react-devdotto)
[](https://github.com/genialkartik/react-devdotto)
## Installation
using NPM:
```bash
npm install --save react-devdotto
```
using YARN:
```bash
yarn add react-devdotto
```
## Usage
```jsx
import DevDotTo from "react-devdotto";
const App = () => {
return (
<DevDotTo
username="genialkartik"
coverimage={true}
darkMode={true}
hideTags={false}
numberOfPosts={5}
/>
);
};
export default App;
```
## Props
Props of the `DevDotTo` component are avilable below.
| Name | Type | Default | Description |
| ------------- | ------- | ------------ | ------------------------------------------------------------------------------------- |
| username | string | genialkartik | `username` can be found on [dev.to](https://dev.to) platform |
| coverimage | boolean | true | if `false`, feature image (cover image) will be replace with description of the blog. |
| darkMode | boolean | true | toggle to `false`, to view blogs list in light mode. |
| hideTags | boolean | false | use to hide tags in blogs list. |
| numberOfPosts | number | | get specific number of posts. |
<br/>
## Contribute
- Fork or Clone this Repository.
- Navigate `cd react-devdotto`.
- run `npm install` to install all required dependencies.
- Make changes or fix bug.
- Make sure to run build `npm build` before commiting all changes.
- Raise a pull request.<br>
Now lemme buy you a coffee :coffee:.
## License
MIT © [genialkartik](https://github.com/genialkartik)