New Project – Steem Editor – A Vue Markdown Editor optimized for the Steem Blockchain

in #content6 years ago

X37EMQ9WSwsLaUVnWj5v4rfuehQsoVtukrb5zwdXbo5aA1Ad39Ag3xeAuevFPTskBTvSScNtCFEshqLeQCPAyMEGY7hKGn167pSCE.png

Repository
https://github.com/BuildTeamDev/steem-editor

New Projects
On behalf of @buildteam I would like to introduce you to SteemEditor, the new Vue Markdown Editor Component build for the Steem Blockchain.

We forked from https://github.com/hinesboy/mavonEditor which @steempeak is currently using (they are planning to switch to our editor too). The TokenBB project is already using it.

Our Story
Every frontend on Steem needs a markdown editor. And to be honest, they are all somewhat broken and either don't do enough or do so much that they become a security risk.

When we were building TokenBB we were facing the same problem. We asked the @steempeak folks how they handled it and they told us they were displeased with their current editor but strapped for time to replace/fix it. So we went to leverage the power of open source to the advantage of Steem.

The editor we are developing comes with a MIT license of do almost whatever you want and encourages forks and change. It is used in real projects and will be ready for Steem markdown out of the box. Important security features have to be implemented once and automatically work for all frontends using it. And everyone can contribute to it, powered by @utopian-io.

The forked editor
mavonEditor is a markdown editor wtih many features current editors for Steem do not support:

X37EMQ9WSwsLaUVnWj5v4rfuehQsoVtukrb5zwdXbo5aA1Ad39Ag3xeAuevFPTskBTvSScNtCFEsgbbK9cUccgbcNa3VX4PY5QDRG.png

It supports emojis (also auto replaced ones like :) and :tm:), allows latex formulas, code in many syntax highlightings and many more. Try out https://md.zhystar.com/ for a big list of features supported already.

mavonEditor is a Vue.js component and uses markdown-it for rendering. We feel this is a great stack for our preferred editor of choice. markdown-it introces itself as: Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed https://markdown-it.github.io

Using such a versatile markdown renderer will allow us to easily add new formats to our markdown, maybe render dtube videos inline or display SteemMonsters cards with a >Selena Sky<, the sky is the limit.

What we already improved
Sadly the editor is somewhat abandoned for 6 months now:
image.png

So we first checked all existing pull requests and included the ones that made sense. Then we updated all dependencies to new versions to fix some security issues with outdated packages.

And then we exported the markdown renderer as a global vue function, so any component can render markdown content as html. See how easy it was to add markdown rendering to TokenBB:

X37EMQ9WSwsLaUVnWj5v4rfuehQsoVtukrb5zwdXbo5aA1Ad39Ag3xeAuevFPTskBTvSScNtCFEsgvoExNodyWKSRX5VwcvW3JqP4.png

Since we use the same renderer the editor uses, all formatting will be exactly the same as the editor preview window shows. This gives the user predictability about how their post will look and saves frontend developers time that they can use to develop awesome features instead of fighting weird formatting bugs.

Roadmap
The goal of this editor is to be the de-facto default editor of Steem. It will be used is popular frontends and therefore we expect new features to happen when users request them. The end goal would be to have new frontend developers add the vue component into their app, change about 10 lines of code and have a working editor with preview and renderer that works in ways users are used to and happy with.

We plan to utilize utopian task requests to add new features to our editor and to reward contributors as much as possible. Many Steem users will thank you for your contribution.

Suggested steps:

Check https://github.com/BuildTeamDev/steem-editor/issues if you find an issues you like working on or create your own
Start a discussion on how you would like to solve the issue
Once a path forward is clear, fork the repository
Code your contribution
Make a pull request to the master branch
The pr will be reviewed by maintainers
Once the pr is accepted and merged, write a Steem post about it to be rewarded through utopian-io

GitHub Account
https://github.com/reggaemuffin

Sort:  

Warning! This user is on my black list, likely as a known plagiarist, spammer or ID thief. Please be cautious with this post!
If you believe this is an error, please chat with us in the #cheetah-appeals channel in our discord.