Skip to content

Commit 141c8cb

Browse files
committed
IMP: Restore README.md
1 parent c282d52 commit 141c8cb

1 file changed

Lines changed: 87 additions & 1 deletion

File tree

README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,87 @@
1-
# magento2-module-wordpress-integration-cms-blog
1+
<div align="center">
2+
3+
![Magento screenshot](assets/preview.png)
4+
5+
</div>
6+
7+
<h1 align="center">Mooore Wordpress Integration Cms</h1>
8+
9+
[![Packagist Version](https://img.shields.io/packagist/v/mooore/magento2-module-wordpress-integration-cms)](https://packagist.org/packages/mooore/magento2-module-wordpress-integration-cms)
10+
![Supported Magento Versions](https://img.shields.io/badge/magento-%202.3_|_2.4-brightgreen.svg?logo=magento&longCache=true)
11+
[![Compatible with Hyva](https://img.shields.io/badge/Compatible_with-Hyva-3df0af.svg?longCache=true)](https://hyva.io/)
12+
![license](https://img.shields.io/github/license/mooore-digital/magento2-module-wordpress-integration-cms)
13+
14+
Magento 2 module for integrating Wordpress pages in to your Magento 2 frontend.
15+
Giving you the power of a real CMS system via Wordpress inside Magento 2.
16+
17+
## Installation
18+
19+
```bash
20+
composer require mooore/magento2-module-wordpress-integration-cms
21+
bin/magento setup:upgrade
22+
```
23+
24+
> :warning: This module is still in its Beta phase.
25+
> So with any new version it might break something from the previous version.
26+
> Use at your own risk.
27+
## How to use
28+
29+
When the module is installed.
30+
You can add your wordpress domain to the `Content > Wordpress Sites`.
31+
_This is the base URL._
32+
33+
After this, all pages will be available as dropdown in your Magento CMS pages.
34+
35+
For more in-depth instructions please see the [wiki](https://github.com/mooore-digital/magento2-module-wordpress-integration-cms/wiki)
36+
37+
### Styles/Script
38+
39+
All styles are loaded by default with your theme.
40+
41+
The blocks are loaded as an separate style for only Wordpress Integration pages.
42+
43+
The custom styles are loaded with your main theme styles,
44+
which offers an option to hook in to the Wordpress block styles.
45+
46+
_This works for the Luma (LESS), Snowdog Blank (SCSS) and Hyva themes._
47+
48+
## Support
49+
50+
Is something missing or found a bug.
51+
Feel free to support this Module by adding a Issue or Pull Request.
52+
53+
Have something cool that extend on this module share it
54+
55+
### Block Compatibility Issues
56+
57+
If a block does match your Wordpress styling or is missing a feature,
58+
please first check the following points before opening a issues;
59+
60+
<details><summary>Your Wordpress theme is made for the new full page editing</summary>
61+
62+
If this is the case,
63+
please take note these block styles are not compatible for any themes that support full page editing.
64+
65+
This could be for example the TwentyTwentyTwo theme.
66+
67+
You can do the following options;
68+
69+
- Use an older theme like TwentyTwentyOne
70+
- Disable the block options
71+
72+
</details>
73+
74+
<details><summary>My theme has an option that does not show on the Magento 2 side</summary>
75+
76+
This can mean 2 posible things;
77+
78+
1. Your custom option has no styles on the Magento side
79+
2. Your custom option creates inline styles on the Wordpress side
80+
81+
If it is option **1** you also have an class that with that custom option,
82+
simply add the required styles to that class.
83+
84+
if it is options **2** then there is nothing you can do for now,
85+
except disable the option on the Wordpress side.
86+
87+
</details>

0 commit comments

Comments
 (0)