Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeldeondsouza/nave_readmegenerator
Nave is a ReadMe editor built using React. It allows users to select from a variety of templates, edit content, and view the rendered output in real-time.
https://github.com/joeldeondsouza/nave_readmegenerator
editor javascript markdown react readme styled-components typescript
Last synced: 22 days ago
JSON representation
Nave is a ReadMe editor built using React. It allows users to select from a variety of templates, edit content, and view the rendered output in real-time.
- Host: GitHub
- URL: https://github.com/joeldeondsouza/nave_readmegenerator
- Owner: JoelDeonDsouza
- Created: 2024-04-07T17:28:49.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-07T19:58:05.000Z (9 months ago)
- Last Synced: 2024-04-08T21:22:22.638Z (9 months ago)
- Topics: editor, javascript, markdown, react, readme, styled-components, typescript
- Language: TypeScript
- Homepage: https://nave-readme-editor.onrender.com
- Size: 398 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# πNave
Nave is a ReadMe editor built using React. It allows users to select from a variety of templates, edit content, and view the rendered output in real-time.
## Tech Stack
**Client:** React, Styled Components.
## Dependency package
Check out react-markdown
```bash
https://www.npmjs.com/package/react-markdown/v/8.0.6
```## Screenshots
![App Screenshot](https://i.ibb.co/v1b9zfx/img.png)
## Features
- Template Selection: Users can choose from a selection of pre-defined templates to start editing their Markdown content.
- Real-time Editing: Content editing is facilitated with a live preview of the Markdown output.
- Copy to Clipboard: Users can easily copy the edited Markdown content to their clipboard with a single click.## Installation
```bash
https://github.com/JoelDeonDsouza/Nave_ReadMeGenerator.git
``````bash
npm install
```## Usage
To start the server, run:
```bash
npm start
```