Skip to content

jlozovei/flavored-markdown

Repository files navigation

Flavored Markdown

In-browser markdown editor with flavors 🍦
See it in action at flavored-markdown.app.

📜 About

A live markdown editor to create nice looking .md files.

The project was created with vue-cli. Written in Vue, it uses vuex as state manager. To parse/render the markdown, using marked with emoji-js.

Using npm as the package manager.

You can switch the rendered HTML's style between:

  • Azure Markdown Style: Guide
  • Bitbucket Markdown Style: Guide
  • GitHub Markdown Style: Guide | Style
  • GitLab Markdown Style: Guide | User Docs
  • npm Markdown Style
  • Yarn Markdown Style

✨ Related

Here are other cool live markdown editors:

And some nice markdown editors:

📝 Contributing

You can contribute to this project following the steps below:

  • Fork the repo
  • Create a new branch
  • Do the work
  • Fill a PR, assign it to you and, if possible, write a cool description
  • Wait for the review

Also, take a look at the contributing guide!

💻 Developing

After forking and cloning the project in your local environment, run the following commands:

# install dependencies
npm i
# or yarn

# run the project at localhost:8000
npm start
# or yarn start

🔐 License

Licensed under the MIT License.