Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated README to for more clarity #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Equation Editor plugin for [TinyMCE](http://www.tinymce.com/) that uses [Mathqui

Refer to [example/example.html](example/example.html) for an example. Note that if you have the repository cloned locally and want to see it in action, you'll need to have it running in a server (i.e. `cd tinymce_equation_editor`; `python -m SimpleHTTPServer` and then going to http://localhost:8000/example/example.html)

Download [tinymce\_equation\_editor.zip](build/tinymce_equation_editor.zip).
Download [tinymce\_equation\_editor.zip](build/tinymce_equation_editor.zip) and rename to `equationeditor`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the point in renaming the zip file?

Copy link
Author

@aakashtushar aakashtushar Jan 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't mean to rename the zip file but the folder. Don't you think, to load plugin in tinymce with 'equationeditor', folder name should be same?


You'll get the following files:
- equation_editor.css
Expand All @@ -31,7 +31,6 @@ Here's an example initialization of TinyMCE. Note that you need to load equation
Anywhere that you display text that could include equations, you will need to include the Mathquill JS and CSS.

```javascript
tinymce.PluginManager.load('equationeditor', '/path/to/plugin.min.js');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the equation editor JS need to be at a specific path for it to be automatically loaded now?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tinymce will detect plugin.js or plugin.min.js if equationeditor was pointed in tinymce.


tinymce.init({
selector: 'textarea',
Expand Down