Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schumacherfm/magento-markdown
Markdown as module for Magento! Replaces the TinyMCE editor. Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
https://github.com/schumacherfm/magento-markdown
Last synced: 17 days ago
JSON representation
Markdown as module for Magento! Replaces the TinyMCE editor. Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
- Host: GitHub
- URL: https://github.com/schumacherfm/magento-markdown
- Owner: SchumacherFM
- Created: 2013-07-14T07:10:17.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-06-08T18:10:41.000Z (over 6 years ago)
- Last Synced: 2024-04-14T14:26:13.869Z (9 months ago)
- Language: JavaScript
- Size: 1000 KB
- Stars: 64
- Watchers: 8
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Magento: Mage Markdown Module [M↓]
==================================
Markdown is a text-to-HTML conversion tool for web writers. Markdown
allows you to write using an easy-to-read, easy-to-write plain text
format, then convert it to structurally valid XHTML (or HTML).
- Full support of [Markdown Extra](http://michelf.ca/projects/php-markdown/extra/)
- Renders all CMS pages and all CMS blocks (Mage_Cms_Block_Block and Mage_Cms_Block_Widget_Block)
- Renders every transactional email as Markdown (or MD Extra)
- Rendering of catalog product and category short and long description fields have to be implemented in the phtml files by yourself.
- Integrates the [EpicEditor](http://epiceditor.com): split fullscreen editing, live previewing, automatic draft saving and offline support. [1]
- Drag'n'Drop, Copy'n'Past and classical file upload of images supported in textarea fields. [Automatic image uploading](https://developer.mozilla
.org/en-US/docs/Web/API/FileReader) integrated (>=IE10, Safari 6.0.2, FX3.6, Chrome 7, Opera 12.02)
- Converting of HTML into Markdown. Client side via JavaScript.
- Preview mode either via on-the-fly of rendered markdown or its HTML or Live Preview of the current page by choosing the approriate store view
- Set permission per role under System -> Permissions -> Role that user can see different parts of the Markdown Editor
Full documentation of Markdown's syntax is available on [John's Markdown page](http://daringfireball.net/projects/markdown/)
[1] Will be maybe removed in future versions
Why do I need this?
-------------------
Because you want to get rid of the TinyMCE and force your customer to use easy and limited syntax.
You can also edit your markdown text with external editors:
#### Mac OS X
- [Mou The missing Markdown editor for web developers](http://mouapp.com/)
- [Lightpaper for Mac](http://clockworkengine.com/lightpaper-mac/)
#### All platforms
- PhpStorm
- Sublime Text
- Cloud based: [StackEdit](http://benweet.github.io/stackedit/)
#### Windows
- [MarkdownPad is a full-featured Markdown editor for Windows](http://markdownpad.com/)
### Mashable: [78 Tools for Writing and Previewing Markdown](http://mashable.com/2013/06/24/markdown-tools/)
Configuration
-------------
All options can be set per store view.
- Enable or disable Markdown parser
- Enable or disable Markdown extra parser
- Set permissions per role in System -> Permissions -> Roles
- Set Markdown detection tag
- Hide Image Insert button
- Enable/Disable markdown rendering in email template
- HTML Source Preview Style CSS, choose one of ~20 different themes
- Markdown Preview Style CSS, choose one of 9 different themes
- Configure the CSS Style for all three preview iFrames
- Add path to css file if using in transactional emails
- Enable or disable Markdown EpicEditor (Default disabled)
- Enable or disable loading of the EpicEditor via click in a textarea field
- Full configuration for Markdown EpicEditor - add a JSON object in the System -> Configuration section
- Defining a custom upload folder for image upload. This folder will be created automatically and recursively
- Enable or disable HTML to Markdown converter reMarked.js
- Full configuration for converter reMarked.js. Add a JSON object in the System -> Configuration section
- Integrate Markdown into your own module by adding the layout handle into the System -> Configuration section
Every field which contains Markdown syntax must contain that detection tag otherwise it will not be parsed.
File upload via Drag'n'Drop works only if you click on the textarea field once. During drag mode a green border will show that file upload
via Drag'n'Drop is available. If you do not see that border during a drag then there will be no file upload.
Demo Content: [http://daringfireball.net/projects/markdown/syntax.text](http://daringfireball.net/projects/markdown/syntax.text)
Bugs
----
#### CSS in transactional emails
CSS is included in the transactional emails in their style tag. Maybe some mail providers removes that style tag
or cannot render it. So maybe there has to be some transformation that the CSS will be added
into each html tag attribute: style.
```
```
Developer Usage
---------------
Anywhere in a .phtml file you can access the renderer via:
```
render($_description, [array $options] ); ?>
```
If you need support for Magento Variables, including Images, you should render the original Magento output. For example, in catalog/product/view/description.phtml, one would use the following code to render markdown, including images and/or other Magento variables:
```
render($this->helper('catalog/output')->productAttribute($this->getProduct(), $_description, 'description')); ?>
```
Catalog product and category description fields have already enabled the markdown feature in the backend. For the frontend
you have to implement the above mentioned code.
CMS pages (instance of Mage_Cms_Model_Page) and blocks (instance of Mage_Cms_Block_Block and
Mage_Cms_Block_Widget_Block) will be rendered automatically but only if the detection tag is present.
Magento Widgets and Variables will be automatically preserved and correctly rendered:
```
{{(widget|config|media|...) ... }}
```
#### Configuring the Markdown parser for custom usage
```
$instance = Mage::getModel('markdown/markdown_render');
$renderer = $instance=>getRenderer();
$renderer->empty_element_suffix = '>';
$renderer->tab_width = 5;
$instance->setOptions(array(
'force' => FALSE, // force rendering even if not markdown
'protectMagento' => TRUE, // protect Magento widgets/variables ...
'extra' => FALSE, // force rendering of markdown extra if true
));
echo $instance->renderMarkdown('text goes here');
```
#### Tips for parsing transactional emails with Markdown Extra
- Remove body tags
- Use ```
``` including markdown=1 in other tags works not always properly
#### How to integrate markdown into my module?
...
#### Modifying the backend
You can add an event to the Markdown observer which generates the backend view.
```php
Mage::dispatchEvent('markdown_merge_after_element_html', array(
'instance' => $this,
));
```
Todo
----
- For version 3.0 replace the EpicEditor with StackEdit
- Create a version for Magento2
Installation Instructions
-------------------------
1. Install modman from https://github.com/colinmollenhour/modman
2. Switch to Magento root folder
3. `modman init`
4. `modman clone git://github.com/SchumacherFM/Magento-Markdown.git`
Please read the great article from Vinai: [Composer installation](http://magebase.com/magento-tutorials/composer-with-magento/)
About
-----
- Key: SchumacherFM_Markdown
- Current Version: 2.2.0
- [Download tarball](https://github.com/SchumacherFM/Magento-Markdown/tags)
- Donation: [http://www.seashepherd.org/](http://www.seashepherd.org/)
History
-------
#### 2.2.1
- Fix live preview URL (Paul)
- Fix system.xml module definition (Paul)
- Fix #39 #42: Hidden Insert ImageButton is always hidden.
- Fix: Custom Layout Handler does not work with array_flip #40
#### 2.2.0
- Update PHP Markdown Lib to version 1.4.1 (4 May 2014) For more details see [here](https://github.com/michelf/php-markdown)
- Update reMarked.js to latest version
- Update marked.js to latest version. Fixes some regex bugs
#### 2.1.1
- Update EpicEditor
- Update marked.js to version v0.3.2
- Update reMarked.js to latest version which fixes a lot of bugs
- Tiny update of beautify-html.js (AMD)
- Update highlight.js to version 8.0 http://highlightjs.org; new themes
- Remove shortened array syntax (PHP 5.4 feature). Thanks [Dan Gibbs](https://github.com/Gibbs)!
- Bug fix: Hide markdown in email editor when it is disabled. Thanks Paul Hachmang!
#### 2.1.0
- Enable/Disable markdown rendering in email template. (by Paul Hachmang)
- Update marked.js
- Bug fix: HTML Preview code markup
- Bug fix: HTML preview button should be removed
- Bug fix: When there is no content, the Preview and Live Preview tabs show incorrect request
- Feature: Feedback and ideas after being used in the wild.
- Feature: Settings to enable/disable Preview, Live Preview and HTML Preview tabs (See Permissions -> Roles)
- Merged Pull Request [More native-like styling](https://github.com/SchumacherFM/Magento-Markdown/pull/20)
- Add new option for styling of the backend textarea field
- Major changes in the backend Github Issue #18
- Renaming of buttons
- EpicEditor disabled by default
- Better style for the textarea field with outer glow
- Besides image Drag'n'Drop added file upload and copy and paste for images
- Enhanced preview mode
#### 2.0.2
- Minor bug fix. Github Issue #17 (wrong module name) and #13 (reMarked.js fixed empty thead)
#### 2.0.1
- Minor bug fix. Github Issue #14
#### 2.0.0
- Major changes
- Remove support for <= IE8
- Add [EpicEditor](http://epiceditor.com) with built in marked.js, split fullscreen editing,
live previewing, automatic draft saving and offline support.
Down side: when inserting Magento widgets, images or variables you have to turn of the editor to insert that item
and then turn it on. (Missing bi-directional synchronization between textarea and editor)
- Preview of HTML source code possible even if EpicEditor is not loaded or disabled.
- If EpicEditor is unloaded then dropping image files with direct upload is possible [HTML5 FileReader](http://bgrins.github.io/filereader.js/).
Due the contenteditable mode in EpicEditor the FileReader cannot be implemented, only in a textarea field ...
- Add reMarked.js to convert HTML into Markdown. reMarked.js is fully configurable via a JSON object.
#### 1.4.2
- Magento Connect
- Compatibility Magento >= 1.5
#### 1.4.1
- Fix readme
- Magento Connect
#### 1.4.0
- Update readme
- Add modified markdown logo from [https://github.com/dcurtis/markdown-mark](https://github.com/dcurtis/markdown-mark)
- Tiny rename to Mage Markdown due to Magento Connect guidelines
- Live preview in CMS Editor fields (not for Markdown Extra)
- Email Templates can have Markdown Extra mode while the default config is "normal" Markdown mode
- Implementing your own renderer must implement SchumacherFM_Markdown_Model_Markdown_Interface
#### 1.3.0
- Backend preview for Markdown Extra via ajax loading
#### 1.2.0
- Use Markdown in transactional emails
- Bug fixes
#### 1.1.0
- Update Markdown parser
- Implemented Markdown extra
#### 1.0.0
- Initial Release
Compatibility
-------------
- Magento >= 1.5
- php >= 5.2.0
There exists the possibility that this extension may work with pre-1.5 Magento versions.
Support / Contribution
----------------------
Report a bug using the issue tracker or send us a pull request.
Instead of forking I can add you as a Collaborator IF you really intend to develop on this module. Just ask :-)
We work with: [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/) and [Semantic Versioning 2.0.0](http://semver.org/)
Licence BSD-3-Clause
--------------------
#### Magento Markdown Implementation
Copyright (c) 2014 Cyrill (at) Schumacher dot fm
All rights reserved.
#### PHP Markdown Lib
- Copyright (c) 2004-2014 Michel Fortin
- [http://michelf.ca](http://michelf.ca)
- [https://github.com/michelf/php-markdown/](https://github.com/michelf/php-markdown/)
#### reMarked.js
- Copyright (c) 2014 Leon Sorokin / leeoniya
- [https://github.com/leeoniya/reMarked.js](https://github.com/leeoniya/reMarked.js)
#### marked.js
- Copyright (c) 2011-2014, Christopher Jeffrey. (MIT Licensed)
- [https://github.com/chjj/marked](https://github.com/chjj/marked)
#### highlight.js
- Copyright (c) 2006, Ivan Sagalaev
- [https://github.com/isagalaev/highlight.js](https://github.com/isagalaev/highlight.js)
#### Markdown Styles
- [http://mixu.net/markdown-styles/](http://mixu.net/markdown-styles/)
#### beautify-html
- Copyright (c) 2007-2014 Einar Lielmanis and contributors.
- [https://github.com/einars/js-beautify/blob/master/js/lib/beautify-html.js](https://github.com/einars/js-beautify/blob/master/js/lib/beautify-html.js)
#### EpicEditor
- Copyright (c) 2011-2014, Oscar Godson (http://oscargodson.com)
- [https://github.com/OscarGodson/EpicEditor](https://github.com/OscarGodson/EpicEditor)
#### Based on Markdown
Copyright (c) 2003-2005 John Gruber
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the
distribution.
* Neither the name "Markdown" nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.
This software is provided by the copyright holders and contributors "as
is" and any express or implied warranties, including, but not limited
to, the implied warranties of merchantability and fitness for a
particular purpose are disclaimed. In no event shall the copyright owner
or contributors be liable for any direct, indirect, incidental, special,
exemplary, or consequential damages (including, but not limited to,
procurement of substitute goods or services; loss of use, data, or
profits; or business interruption) however caused and on any theory of
liability, whether in contract, strict liability, or tort (including
negligence or otherwise) arising in any way out of the use of this
software, even if advised of the possibility of such damage.
Backend preview rendering via:
* marked - a markdown parser
* Copyright (c) 2011-2013, Christopher Jeffrey. (MIT Licensed)
* https://github.com/chjj/marked
Author
------
[Cyrill Schumacher](https://github.com/SchumacherFM) - [My pgp public key](http://www.schumacher.fm/cyrill.asc)
[@SchumacherFM](https://twitter.com/SchumacherFM)
Made in Sydney, Australia :-)
If you consider a donation please contribute to: [http://www.seashepherd.org/](http://www.seashepherd.org/)