Skip to content

create and then download github readme files with live preview, it also has some built in templates .

Notifications You must be signed in to change notification settings

victorakaps/github-readme-maker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github Readme Maker

N|Solid

Build Status

Github Readme Maker is a cloud-enabled, mobile-ready, offline-storage, ReactJS powered HTML5 Markdown editor.

-> Type some Markdown on the left
-> See HTML in the right
-> Magic 

New Features!

Import a markdown file and watch it magically appear in preview window

Tech

Github Readme Maker uses a number of open source projects to work properly:

  • React - HTML enhanced for web apps!
  • marked - Markdown parser done right. Fast and easy to extend.
  • MaterializeCSS - great UI boilerplate for modern web apps
  • node.js - evented I/O for the backend

And of course Github Readme Maker itself is open source with a public repository on GitHub.

Installation

Github Readme Maker requires Node.js v7+ to run.

Install the dependencies and devDependencies and start the server.
$ cd github-readme-maker
$ npm install -d
$ npm run start
For production
$ npm run build

Todos

  • Write MORE Templates
  • Toggle Night Mode

License

MIT

Free Software, Hell Yeah!

About

create and then download github readme files with live preview, it also has some built in templates .

Topics

Resources

Stars

Watchers

Forks