Skip to content
/ makeme Public

✏️ Create quick, engaging, and attractive README's with MAKEME.md. Side by side rendering of markdown to readme in real time, with easy to add components and templates.

Notifications You must be signed in to change notification settings

RareTC/makeme

Repository files navigation

MAKEME.md

A MERN Stack Web Based Application

LinkedIn Badge

Portfolio View

📝 Description

Welcome to MAKEME.md! A MERN-based app that lets you create beautiful and functional README.md files quickly and easily. With side-by-side viewing feature, you can see your markdown changes in real time as you work. The left-hand menu provides easy access to commonly used markdown components, as well as templates that can help jumpstart your README creation process.

MAKEME.md is modeled after Github's own README.md, so you can trust that your readme will look great and be easily readable. With the ability to log in, you can save your ongoing projects and come back to them later. Plus, with access to your past projects, you can easily find and reference READMEs you've created in the past.

Try MAKEME.md today and see how easy it is to create polished, professional READMEs in no time

📸 Screenshots

Description Screenshot

Login

Home Page

Templates

Live Viewing

💻 Technologies

React MongoDB Node Express JavaScript HTML5 CSS3 JWT Markdown Github VSCode Heroku MaterialUI

⚛️ Getting Started

1. After Signing up with a unique email, you have access to the Markdown generator.
2. The page is user friendly, and features components on the left hand side to quickly add markdown text. 
3. Need more guidance? No worries, click the templates next to the saved menu and you can use one of my premade templates.
4. Not done? Go ahead and name your project and click save to return to it later. 
5. When you return just click the dropdown arrow in the "View Saved" menu to pul your progress back up! 

👀 Upcoming Features

  • [:x:] Allow nonexisting users to utilize the page with limited functionality.

  • [:x:] Copy Button added to markdown.

  • [:x:] More Components to add.

  • [:x:] Add HTML elements to Readme component.

  • [:x:] Add a contact form for users to suggest new components.

About

✏️ Create quick, engaging, and attractive README's with MAKEME.md. Side by side rendering of markdown to readme in real time, with easy to add components and templates.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published