https://github.com/pioul/Minimalist-Online-Markdown-Editor

This is the simplest and slickest online Markdown editor.
https://github.com/pioul/Minimalist-Online-Markdown-Editor

Last synced: about 1 month ago
JSON representation

This is the simplest and slickest online Markdown editor.

• Host: GitHub
• URL: https://github.com/pioul/Minimalist-Online-Markdown-Editor
• Owner: pioul
• License: mit
• Created: 2013-08-03T20:29:52.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-09-13T10:21:36.000Z (about 2 years ago)
• Last Synced: 2024-08-01T12:31:08.072Z (4 months ago)
• Language: JavaScript
• Homepage: http://markdown.pioul.fr
• Size: 482 KB
• Stars: 264
• Watchers: 12
• Forks: 44
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-markdown-editors - `pioul/Minimalist-Online-Markdown-Editor`
• awesome-starred - pioul/Minimalist-Online-Markdown-Editor - This is the simplest and slickest online Markdown editor. (others)

README

        
# Minimalist Online Markdown Editor

This is the source for the **simplest** and **slickest** online Markdown editor, available online here:   

Just write Markdown and see what it looks like as you type. And convert it to HTML in one click.

## The Minimalist Markdown Editor project

The Minimalist Markdown Editor project is available both online as a web app, and offline and with file support as a Chrome app:

- [Web app](http://markdown.pioul.fr) (the source code is in this repo)

- [Chrome app](https://chrome.google.com/webstore/detail/minimalist-markdown-edito/pghodfjepegmciihfhdipmimghiakcjf) ([GitHub repository](https://github.com/pioul/Minimalist-Markdown-Editor-for-Chrome))

## Contributing

### Building

1. Ensure that [Node.js](http://nodejs.org/) is installed, and open a terminal in the project's root directory.

2. Run `npm install` to install the project's developement dependencies.

3. Run `npm run build` to build the web app. The builds will be placed in the `dist/` directory.

Note: Building should only be necessary if you think about contributing. If you want to run one of the apps, hit one of the links above.

### Git workflow

The two project branches share a decent amount of code. This common source code sits in `app-shared/` in each of these repos. As you can see from the commit history, changes to files in- and outside of `app-shared/` are committed separately to help with cherry-picking the common source changes from the other repo afterward.

E.g. You've made changes to `src/css/main.css` and `src/app-shared/css/main.css`. Since changes have been made to files in- and outside of `app-shared/`, instead of committing all changes at once, make two commits:

1. The first one will be called "[app-shared] commit_message", and will commit changes to `src/app-shared/css/main.css`.

2. The second one will be called "commit_message", and will commit changes to `src/css/main.css`.

If changes had only been made to `src/css/main.css`, then there would've been no need for the first commit. And if changes had only been made to `src/app-shared/css/main.css`, there would've been no need for the second commit.

That's really all there is to know about this project's Git workflow, so fork away!

### Target env

We aim at compatibility down to IE9.

The source for this app is currently authored in ES5, with ES5 polyfills when needed. I'm thinking about authoring in ES6+ and transpiling + polyfilling, but that'd require lots of carefully picked ES6+ polyfills to run in most browsers, so I'm waiting for a good reason to do so.