https://github.com/G3root/readme-generator

A fully featured editor with drag and drop interface to easily build READMEs
https://github.com/G3root/readme-generator

daisyui drag-and-drop jotai markdown nextjs react readme readme-profile tailwindcss

Last synced: 3 months ago
JSON representation

A fully featured editor with drag and drop interface to easily build READMEs

• Host: GitHub
• URL: https://github.com/G3root/readme-generator
• Owner: G3root
• License: mit
• Created: 2022-03-11T05:51:18.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-03-31T05:59:04.000Z (over 2 years ago)
• Last Synced: 2024-05-23T01:32:32.362Z (6 months ago)
• Topics: daisyui, drag-and-drop, jotai, markdown, nextjs, react, readme, readme-profile, tailwindcss
• Language: TypeScript
• Homepage: https://nxt-readme.vercel.app/
• Size: 377 KB
• Stars: 93
• Watchers: 3
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - G3root/readme-generator - A fully featured editor with drag and drop interface to easily build READMEs (TypeScript)

README

        
[![GitHub license](https://img.shields.io/badge/license-MIT-green)](LICENSE)

![GitHub issues](https://img.shields.io/github/issues/G3root/readme-generator)

![GitHub pull requests](https://img.shields.io/github/issues-pr/G3root/readme-generator)

![GitHub stars](https://img.shields.io/github/stars/G3root/readme-generator?style=social)

![GitHub stars](https://img.shields.io/github/forks/G3root/readme-generator?style=social)

![GitHub stars](https://img.shields.io/github/watchers/G3root/readme-generator?style=social)

![GitHub follow](https://img.shields.io/github/followers/G3root?label=Follow&style=social)

## 🗎 Readme Generator

A fully featured editor with drag and drop interface to create your README's with speed.

## 🚀 Demo

site link : [GitHub README Generator](https://nxt-readme.vercel.app/)

## 🏃 Running Locally

```bash

$ git clone https://github.com/G3root/readme-generator.git

$ cd readme-generator

$ yarn install

$ yarn start

```




## 🛠 Built With

- [Next.js](https://nextjs.org/)

- [TypeScript](https://www.typescriptlang.org/)

- [Mantine](https://mantine.dev/)

- [Jotai](https://jotai.org/)

- [dnd kit](https://dndkit.com/)

- [react-markdown](https://github.com/remarkjs/react-markdown)




## 🤝 Contribute

If you want to contribute to this app, you're always welcome!

See [Contributing Guidelines](https://github.com/G3root/readme-generator/blob/master/CONTRIBUTING.md).




## 📩 Contact

I know that first and foremost you are looking for a tool to solve your problems, but if you enjoy

it that much, why not tell us? We would love to hear from you 😉

DM me at 👇

- Twitter: @nfs\_\_21

- Email: [email protected]




## 🤗 Credits

- Project inspiration [readme.so](https://readme.so/) and [github-profile-readme-generator](https://rahuldkjain.github.io/gh-profile-readme-generator/)




## 🙏 Support

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/G2G473L1O)





Developed with ❤️ in Sri Lanka 🇱🇰