https://github.com/adityasinghvats/visual-markdown
A live markdown to HTML / Text convertor built to preview markdown ( .md ) files before making attractive README files.
https://github.com/adityasinghvats/visual-markdown
css ejs express html nodejs showdownjs
Last synced: 3 months ago
JSON representation
A live markdown to HTML / Text convertor built to preview markdown ( .md ) files before making attractive README files.
- Host: GitHub
- URL: https://github.com/adityasinghvats/visual-markdown
- Owner: Adityasinghvats
- Created: 2025-01-21T17:57:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-21T18:08:10.000Z (over 1 year ago)
- Last Synced: 2025-01-21T19:23:07.582Z (over 1 year ago)
- Topics: css, ejs, express, html, nodejs, showdownjs
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Realtime Markdown Editor 🪃 😸
### What is this?
Type your markdown into the box on the left and immediately see if on the box on the right.
The editor has the capacity for realtime collaboration using ShareJS.
### How to use this? 🔽
* Clone the repo using
```sh
git clone https://github.com/Adityasinghvats/Visual-MarkDown.git
```
* Open the project in VS Code and go the root directory.
* Run the server using
```sh
node server.js
```
* Access the editor at `localhost:8000`.
### How was this built? 🤔
This website uses the following to work:
- [Showdown](https://github.com/showdownjs/showdown) - Converts markdown text to beautiful HTML
- [ShareJS](http://sharejs.org/) - allows for realtime editing of this textbox
- [Node.js](https://nodejs.org/) - backend framework
- [Redis](http://redis.io/) - where we store our markdown documents
- [Twitter Bootstrap](http://getbootstrap.com/) - makes everything a little prettier
### Demo 😲
