Netsyms/easy-markdown-editor
2
0
Fork 0
mirror of https://github.com/Ionaru/easy-markdown-editor synced 2025-07-21 00:44:28 -06:00
Code Issues Releases Wiki Activity

Add hacking instructions in readme and add minor changes in contribution guide.

Browse Source
This commit is contained in:
Nathanaël Jourdane 2019-02-12 13:42:01 +01:00
parent c46ddde5e0
commit 3437ced229
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -34,9 +34,10 @@ Here we go! 🤠 First, clone this repository:
```bash ```bash
git clone https://github.com/Ionaru/easy-markdown-editor.git git clone https://github.com/Ionaru/easy-markdown-editor.git
cd easy-markdown-editor
``` ```
Then install the EasyMDE for development environment with npm: Then install the EasyMDE with npm:
```bash ```bash
npm install npm install
@ -44,6 +45,7 @@ npm install
Yay! You are ready! 🍾 Yay! You are ready! 🍾
### ⤴️ Creating a pull request ### ⤴️ Creating a pull request
1. First, [create a fork of this project](https://github.com/Ionaru/easy-markdown-editor/fork), and copy the https URL (*clone or download* button) of your project (something like https://github.com/YOUR_USERNAME/easy-markdown-editor.git ); 1. First, [create a fork of this project](https://github.com/Ionaru/easy-markdown-editor/fork), and copy the https URL (*clone or download* button) of your project (something like https://github.com/YOUR_USERNAME/easy-markdown-editor.git );
@ -56,6 +58,6 @@ Yay! You are ready! 🍾
6. push it to a dedicated branch `git push origin myMergeRequest`; 6. push it to a dedicated branch `git push origin myMergeRequest`;
7. got to the [main project page](https://github.com/Ionaru/easy-markdown-editor) and click on the button *Compare and pull request*, then fill the description. 7. got to the [main project page](https://github.com/Ionaru/easy-markdown-editor) and click on the button *Compare and pull request*, then fill the description.
If you want to make other pull requests, go back to the development branch (`git checkout development`), update it (`git pull --rebase source development`), then follow the instructions above from step 3. If you want to make other pull requests, go back to the master branch (`git checkout master`), update it (`git pull --rebase source master`), then follow the instructions above from step 3.
Thank you! 💜 Thank you! 💜

10
README.md
View File

@ -417,6 +417,16 @@ Changes include:
My intention is to continue development on this project, improving it and keeping it alive. My intention is to continue development on this project, improving it and keeping it alive.
## Hacking EasyMDE
You may want to edit this library to adapt its behavior to your needs. This can be done in some quick steps:
1. Follow the [prerequisites](./CONTRIBUTING.md#prerequisites) and [installation](./CONTRIBUTING.md#installation) instructions in the contribution guide;
2. Do your changes;
3. Run `gulp` command, which will generate files: `dist/easymde.min.css` and `dist/easymde.min.js`;
4. Copy-paste those files to your code base, and you are done.
## Contributing ## Contributing
Want to contribute to EasyMDE? Thank you! We have a [contribution guide](./CONTRIBUTING.md) just for you! Want to contribute to EasyMDE? Thank you! We have a [contribution guide](./CONTRIBUTING.md) just for you!