https://github.com/sina-byn/read-u

A web application that assists in creating GitHub README.md files, featuring real-time Markdown preview and a Markdown table editor, both supporting tab synchronization
https://github.com/sina-byn/read-u

gfm markdown markdown-editor readme readme-editor

Last synced: 17 days ago
JSON representation

A web application that assists in creating GitHub README.md files, featuring real-time Markdown preview and a Markdown table editor, both supporting tab synchronization

• Host: GitHub
• URL: https://github.com/sina-byn/read-u
• Owner: sina-byn
• License: mit
• Created: 2024-06-27T10:55:11.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-16T10:23:27.000Z (21 days ago)
• Last Synced: 2024-10-18T02:19:27.897Z (20 days ago)
• Topics: gfm, markdown, markdown-editor, readme, readme-editor
• Language: TypeScript
• Homepage: https://read-u.netlify.app/
• Size: 664 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# READ-U.md

![read-u.md banner](/public/images/banner.png)

A web application that assists in creating GitHub README.md files, featuring real-time Markdown preview and a Markdown table editor, both supporting tab synchronization.

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, run the development server:

```bash

npm run dev

# or

yarn dev

# or

pnpm dev

# or

bun dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Build For Production

```bash

npm run build:all

```

The command above will generate Github markdown's CSS and template's data before building the next app.

Then run:

```bash

npm run start

```

## Contributing

Read [contributing.md](/CONTRIBUTING.md).