https://github.com/jlozovei/flavored-markdown
In-browser markdown editor with flavors :icecream:
https://github.com/jlozovei/flavored-markdown
editor hacktoberfest markdown-editor markdown-previewer markdown-viewer
Last synced: about 1 year ago
JSON representation
In-browser markdown editor with flavors :icecream:
- Host: GitHub
- URL: https://github.com/jlozovei/flavored-markdown
- Owner: jlozovei
- License: mit
- Created: 2018-09-17T01:16:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T13:46:03.000Z (over 2 years ago)
- Last Synced: 2025-04-09T04:03:31.580Z (about 1 year ago)
- Topics: editor, hacktoberfest, markdown-editor, markdown-previewer, markdown-viewer
- Language: CSS
- Homepage: https://flavored-markdown.app
- Size: 14.1 MB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Flavored Markdown
In-browser markdown editor with flavors :icecream:
See it in action at [flavored-markdown.app](https://flavored-markdown.app).
## :scroll: About
A live markdown editor to create nice looking `.md` files.
The project was created with [vue-cli](https://cli.vuejs.org/). Written in [Vue](https://vuejs.org/), it uses [vuex](https://vuex.vuejs.org/) as state manager. To parse/render the markdown, using [marked](https://github.com/markedjs/marked) with [emoji-js](https://github.com/iamcal/js-emoji).
Using [npm](https://npmjs.com) as the package manager.
You can switch the rendered HTML's style between:
- Azure Markdown Style: [Guide](https://docs.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance)
- Bitbucket Markdown Style: [Guide](https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide-776639995.html)
- GitHub Markdown Style: [Guide](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) | [Style](https://primer.style/css/components/markdown)
- GitLab Markdown Style: [Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) | [User Docs](https://docs.gitlab.com/ee/user/markdown.html)
- npm Markdown Style
- Yarn Markdown Style
### :sparkles: Related
Here are other cool live markdown editors:
- [jbt/markdown-editor](https://github.com/jbt/markdown-editor)
- [liyasthomas/marcdown](https://github.com/liyasthomas/marcdown)
- [benweet/stackedit](https://github.com/benweet/stackedit)
And some nice markdown editors:
- [marktext](https://github.com/marktext/marktext) (open-source)
- [Bear](https://bear.app/) (MacOS only)
## :pencil: 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](https://github.com/jlozovei/flavored-markdown/blob/master/.github/CONTRIBUTING.md)!
## :computer: Developing
After forking and cloning the project in your local environment, run the following commands:
```bash
# install dependencies
npm i
# or yarn
# run the project at localhost:8000
npm start
# or yarn start
```
## :closed_lock_with_key: License
Licensed under the [MIT License](https://github.com/jlozovei/flavored-markdown/blob/master/LICENSE).