Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schumacherfm/magento2-markdown
Markdown or Parsedown for Magento2 as template engine
https://github.com/schumacherfm/magento2-markdown
Last synced: 8 days ago
JSON representation
Markdown or Parsedown for Magento2 as template engine
- Host: GitHub
- URL: https://github.com/schumacherfm/magento2-markdown
- Owner: SchumacherFM
- Created: 2015-01-18T10:07:24.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-06-08T18:06:22.000Z (over 6 years ago)
- Last Synced: 2024-04-14T14:26:15.396Z (8 months ago)
- Language: PHP
- Size: 12.7 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Magento2 Markdown Template Engine
============
Markdown template engine for Magento2.
This template engine is meant to be used additionally to the `.phtml` files and does not
provide any `.md` template file.
A use case would be to replace some simple `.phtml` files with Markdown or uses the Markdown template files
as some kind of CMS.
You can write any PHP in the Markdown files. After PHP has been executed the template will be transformed
from Markdown to HTML.
Events & Configuration
-------------
The Markdown template engine class dispatches one event which lets you modify the current parser.
Event name: `markdown_init` with event object: `engine`.
Configuration options can be found Stores -> Settings -> Configuration -> Advanced -> Developer -> Markdown.
You can choose from one of the three engines:
- Michelf (Markdown) [https://michelf.ca/projects/php-markdown/](https://michelf.ca/projects/php-markdown/)
- MichelfExtra (Markdown Extra) [https://michelf.ca/projects/php-markdown/extra/](https://michelf.ca/projects/php-markdown/extra/)
- ParseDown [http://parsedown.org/](http://parsedown.org/)
Default engine is the first one.
Frontend Integration
--------------------
Example use case: Disable WYSIWYG editor and switch the content from the product tables to full Markdown support.
We're deactivating the WYSIWYG editor completely in the backend via the option
`Stores -> Configuration -> General -> Content Management -> WYSIWYG Options` with value `Disable completely`.
As a side effect you backend loads much faster ;-(
Your template files must have the file extension `.md` to get automatically recognized.
In your theme change `catalog_product_view.xml` to
```
getShortDescription
short_description
overview
none
Overview
itemprop="description"
```
Note: We are only changing the template extension.
```
getDescription
description
description
none
Details
```
@todo figure out best method to easily change the template name for those blocks.
These changes mean that product short description and long description will now be parsed with Markdown!
#### Example attribute.phtml converted to attribute.md
[Click here to view the original attribute.phtml](https://github.com/magento/magento2/blob/develop/app%2Fcode%2FMagento%2FCatalog%2Fview%2Ffrontend%2Ftemplates%2Fproduct%2Fview%2Fattribute.phtml)
The next excerpt is from `attribute.md` which only shows the last six lines:
```
... PHP stuff ...
>
```
Note that we add here `markdown="1"` into the div and we must change the parser to `michelfextra`.
That's it! All our product descriptions will now be outputted with Markdown formatting!
A hackathon project could be to replace the WYSIWYG editor with a Markdown editor in the backend.
Developers
----------
If you wish to add any other Markdown engine simply create your own module and add a `di.xml`:
```
\Namespace\Module\MyAwesomeMarkdownParser
```
This entry will also appear in the backend configuration section.
Your `MyAwesomeMarkdownParser` must implement: `MarkdownEngineInterface`.
Tests
-----
@todo
Installation via Composer
------------
Add the following to the require section of your Magento 2 `composer.json` file
"schumacherfm/mage2-markdown": "dev-master"
additionally add the following in the repository section
"repositories": [
{
"type": "vcs",
"url": "https://github.com/SchumacherFM/Magento2-Markdown.git"
}
]
run `composer update`
add the following to `app/etc/config.php`
'SchumacherFM_Markdown'=>1
Compatibility
-------------
- Magento >= 2
- php >= 5.4.0
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 :-)
I am using that model: [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/)
For versioning have a look at [Semantic Versioning 2.0.0](http://semver.org/)
History
-------
#### 0.1.0
- Initial release
License
-------
OSL-30
Author
------
[Cyrill Schumacher](https://cyrillschumacher.com)
[My pgp public key](https://cyrillschumacher.com/cyrill.asc)