|
1 |
| -# magento-bottom-description |
2 |
| -Adds a WYSIWYG-enabled "Bottom Description" attribute to Magento 2 category pages and renders it below the main content. |
| 1 | +# 🛒 Magento 2 Category Bottom Description Extension (FREE) |
| 2 | + |
| 3 | +The **Magento 2 Category Bottom Description** module by SamuelBSource adds a new 📝 WYSIWYG-enabled attribute to product categories called `Bottom Description`. This content is displayed below the main content on the category view page — great for SEO or promotional content. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## 📚 1. Documentation |
| 8 | + |
| 9 | +- 📥 [Installation Guide](#3-how-to-install-category-bottom-description-extension) |
| 10 | +- 📘 [User Guide](#4-highlight-features-of-category-bottom-description) |
| 11 | +- 🔧 [Contribute on GitHub](https://github.com/samuelbsource/module-bottom-description) |
| 12 | +- ❓ [Get Support](https://github.com/samuelbsource/module-bottom-description/issues) |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## 🛠️ 2. How to install Category Bottom Description extension for Magento 2 |
| 17 | + |
| 18 | +### 📦 Install via Packagist (recommended) |
| 19 | + |
| 20 | +```bash |
| 21 | +composer require samuelbsource/module-bottom-description |
| 22 | +bin/magento module:enable SamuelBSource_BottomDescription |
| 23 | +bin/magento setup:upgrade |
| 24 | +bin/magento cache:flush |
| 25 | +``` |
| 26 | + |
| 27 | +### 🐙 Install via GitHub (VCS) |
| 28 | + |
| 29 | +Add the repo to your `composer.json`: |
| 30 | + |
| 31 | +```json |
| 32 | +"repositories": [ |
| 33 | +{ |
| 34 | +"type": "vcs", |
| 35 | +"url": "https://github.com/samuelbsource/module-bottom-description" |
| 36 | +} |
| 37 | +] |
| 38 | +``` |
| 39 | + |
| 40 | +Then run: |
| 41 | + |
| 42 | +```bash |
| 43 | +composer require samuelbsource/module-bottom-description:dev-main |
| 44 | +bin/magento setup:upgrade |
| 45 | +bin/magento cache:flush |
| 46 | +``` |
| 47 | + |
| 48 | +### 🧱 Manual installation |
| 49 | + |
| 50 | +```bash |
| 51 | +git clone https://github.com/samuelbsource/module-bottom-description.git app/code/SamuelBSource/BottomDescription |
| 52 | +bin/magento module:enable SamuelBSource_BottomDescription |
| 53 | +bin/magento setup:upgrade |
| 54 | +bin/magento cache:flush |
| 55 | +``` |
| 56 | + |
| 57 | +--- |
| 58 | + |
| 59 | +## ✨ 3. Highlight Features of Category Bottom Description |
| 60 | + |
| 61 | +### ➕ Adds New Attribute to Categories |
| 62 | + |
| 63 | +A new `bottom_description` attribute is added to all product categories. |
| 64 | + |
| 65 | +- 🏷️ Store-view scoped |
| 66 | +- 📝 Fully WYSIWYG-enabled |
| 67 | +- 📄 The content is injected right after the "columns" element |
| 68 | + |
| 69 | +## 🧪 4. How to Use Category Bottom Description |
| 70 | + |
| 71 | +### ⚙️ Admin Configuration |
| 72 | + |
| 73 | +1. Go to **Catalog > Categories** |
| 74 | +2. Open or create a category |
| 75 | +3. Under **General Information**, fill in the **Bottom Description** field |
| 76 | +4. Save the category |
| 77 | + |
| 78 | +### 👀 Frontend Output |
| 79 | + |
| 80 | +Visit the category page on the frontend. You’ll see the **Bottom Description** appear below the category content and product listing, inside a `<div class="category-bottom">`. |
| 81 | + |
| 82 | + |
| 83 | + You’ll see the **Bottom Description** appear below the category content and product listing, inside a `<div class="category-bottom">`. |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +## 🎨 5. Customization Options |
| 88 | + |
| 89 | +### 🖌️ Change the Template |
| 90 | + |
| 91 | +Override this file in your custom theme to control rendering: |
| 92 | + |
| 93 | +``` |
| 94 | +view/frontend/templates/category/bottom_description.phtml |
| 95 | +``` |
| 96 | + |
| 97 | +Example location in theme: |
| 98 | + |
| 99 | +``` |
| 100 | +app/design/frontend/Vendor/theme/SamuelBSource_BottomDescription/templates/category/bottom_description.phtml |
| 101 | +``` |
| 102 | + |
| 103 | +### 🧩 Adjust Position with Layout XML |
| 104 | + |
| 105 | +Override `catalog_category_view.xml` to reposition or restyle the block. |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +## ✅ 6. Compatibility |
| 110 | + |
| 111 | +- 🧱 Magento Open Source 2.4.x |
| 112 | +- 💼 Magento Commerce 2.4.x |
| 113 | +- 🐘 PHP 8.\* |
| 114 | + |
| 115 | +--- |
| 116 | + |
| 117 | +## 📄 7. License |
| 118 | + |
| 119 | +Released under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). |
| 120 | + |
| 121 | +--- |
| 122 | + |
| 123 | +## 👤 8. Author |
| 124 | + |
| 125 | +**Samuel Boczek** |
| 126 | +Magento Developer / AI Student / Freelancer |
| 127 | +- 🐱 GitHub: [@samuelbsource](https://github.com/samuelbsource) |
| 128 | +- 💼 LinkedIn: [linkedin.com/in/samuel-boczek](https://www.linkedin.com/in/samuel-boczek/) |
| 129 | + |
| 130 | +--- |
| 131 | + |
| 132 | +**🚀 More Magento 2 modules coming soon!** |
| 133 | + |
0 commit comments