Magento 2 Mirasvit Blog MX

Getting Started

Welcome to the documentation of Blog MX for Magento 2 extension.

Whether you are a new or an advanced user, you can find some useful information here.

First of all we recommend you check the following link:

How to install the extension

  1. Backup your store's database and web directory.
  2. Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
  3. Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.
  4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_BlogMx to enable the extension.
  5. Run command php -f bin/magento setup:upgrade to install the extension.
  6. Run command php -f bin/magento cache:clean to clean the cache.

  7. Deploy static view files

    rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Blog MX settings

The settings of Blog Mx are located at Content ▸ Blog MX ▸ Settings and are grouped into the following sections:

  • Appearence - basic configuration of the blog appearence in the frontend.
  • Display - additional configurations related to the blog appearence in the frontend.
  • Search Engine Optimization - SEO settings of the module
  • Comments - settings for comments in posts.
  • Sharing - configurations for sharing blog posts via social networks, email, etc.
  • Layout Settings - configurations related to the way pages of the blog will be displayed on the frontend.

Appearence

  • Top Menu Title - set the title of the blog for the main menu.
  • Blog Name - set the name of the blog that will be displayed on the main page of the blog and in the footer.

  • Date Format - set the way the date will be displayed in the blog pages.

    Example

    • F j, Y - March 10, 2001
    • Y-m-d - 2001-03-10
    • D, M j, Y - Sat, Mar 10, 2001

    Read more about accepted date format characters.

Display

  • Visible Navigation Menu - if enabled, the link to the blog will be added to the main menu of the website.
  • Enable excerpts on list page - When enabled, excerpts will be inserted as follows; if there is a tag in the post's content, the excerpt will go until that tag, next if the post has an excerpt that gets used, lastly, the first n characters of the post (as set below) will be displayed.
  • Default Excerpt Character size - set the limit for the number of symbols of the post content to be displayed on the posts list pages.

Search Engine Optimization

  • Base URL - the URL key for the blog (will be visible in the URLs for all blog pages).
  • Base Meta Title - the part of the page meta title that will be added to all blog pages.
  • Base Meta Description - the part of the meta description that will be added to all blog pages.
  • URL Suffix for Posts - the suffix of the URLs for all blog post pages.
  • URL Suffix for Categories - the suffix of the URLs for all blog category pages.

Comments

  • Provider - choose the provider for comments or disable them. Currently our extension only supports Facebook comments.

Sharing

  • Enable AddThis Sharing Buttons - enable/disable AddThis buttons.

Layout Settings

  • Post Layout - choose the template for blog post pages.
  • Post List Layout - choose the layout for all post list pages (the main page of the blog, category, author, and tag pages).
  • Post List View Mode - select one of the provided view modes for post list pages - List or Grid.
  • Sort posts by - choose the sorting for posts in all post list pages.
  • Posts per Page - set options for post per page appearence (options for pager toolbar). Comma sepparated values. The default value is 10,20,50.

Posts

Go to Content ▸ Blog MX ▸ All Posts. There you'll see all blog posts

post_grid.png

To create a new blog post, click on the Add New Post button and you'll be redirected to the post creation form.

post_form.png

Categories

Go to Content ▸ Blog MX ▸ Categories. There, you'll see the blog categories organized hierarchically

category_grid.png

To create a new category, click on the Add new button and you'll be redirected to the category creation form.
The form is split into 2 tabs:

  • General Information - main settings of the blog category.
  • Search Engine Optimization - SEO configurations.

category_form.png

Authors

Go to Content ▸ Blog MX ▸ Authors. There, you'll see all authors of the blog posts

author_grid.png

To create a new author, click on the Add New Author button and you'll be redirected to the author creation form.

author_form.png

Tags

Go to Content ▸ Blog MX ▸ Tags. There, you'll see all tags of the blog

tag_grid.png

To create a new blog tag, click on the Add New Tag button and you'll be redirected to the tag creation form.

tag_form.png

Widgets

The extension provides you with 2 types of widgets: Vertical and Horizontal.

To add a blog widget, go to Content ▸ Widgets and click on the Add Widget button. You'll be redirected to the widget creation form.

Choose one of the blog widgets, pick your design theme and press the Continue button.
After that, widget configurations will be available (depending on the selected widget type).

You can see an example of the horizontal widget configurations here:

widget_horizontal.png

You can see an example of the vertical widget configurations here:

widget_vertical.png

Vertical widget provides you with the ability to choose the template type of the widget, depending on where you are planning to place it: Full Content or Sidebar.
For the Full content template type, you can also configure the Display Mode of the widget and Excerpts Character Size.

How to upgrade extension

To upgrade the extension, follow these steps:

  1. Backup your store's database and web directory.
  2. Login to your server's SSH console and navigate to the root directory of the Magento 2 store.

  3. Run command composer require mirasvit/module-blog-mx:* --update-with-dependencies to update current extension with all dependencies.

    Note

    There are some cases when the command above is not applicable; it is not possible when updating the current module; neither will it be applicable when upgrading all the Mirasvit modules in a bundle. In this case, the command above will be of no effect.

    Run instead composer update mirasvit/* command. It will update all Mirasvit modules installed in your store.

  4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_BLogMx to enable the extension.
  5. Run command php -f bin/magento setup:upgrade to install updates.
  6. Run command php -f bin/magento cache:clean to clean the cache.

  7. Deploy static view files

    rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Disabling the Extension

Temporarily Disable

To temporarily disable the extension please follow these steps:

  1. Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
  2. Run command php -f bin/magento module:disable Mirasvit_BlogMx to disable the extension.
  3. Log in to the Magento backend and refresh the store cache (if enabled).

Removing the Extension

To uninstall the extension, please follow these steps:

  1. Login to your server's SSH console and navigate to the root directory of the Magento 2 store.
  2. Run the command composer remove mirasvit/module-blog-mx to remove the extension.
  3. Log in to the Magento backend and refresh the store's cache (if enabled).

1.1.14

(2021-12-08)

Fixed

  • Issue with post save if Single-Store Mode is enabled

1.1.13

(2021-10-20)

Fixed

  • Compatibility with Magento Page Builder

1.1.12

(2021-09-29)

Improvements

  • compatibility with third party Page Builder

1.1.11

(2021-09-20)

Fixed

  • Issue when changing status via massaction for Magento 2.3

1.1.10

(2021-09-14)

Fixed

  • Issue wiht rss

1.1.9

(2021-09-14)

Fixed

  • Issue when changing status via massaction

1.1.8

(2021-09-07)

Fixed

  • Issue with Page Buider for Magento 2.4.3

1.1.7

(2021-06-30)

Fixed

  • Issue after delete author,post,category
  • Issue after save author,post,category

1.1.6

(2021-06-15)

Fixed

  • Clean cache on post/category/author save/delete

1.1.5

(2021-06-09)

Fixed

  • Fixed the issue with upgrading extension from free Blog extension

1.1.4

(2021-06-04)

Improvements

  • Added id and sort order columns on categories page

Fixed

  • Issue with display post if featured image not set

1.1.3

(2021-05-25)

Improvements

  • Ability to enable/disable link in the footer

1.1.2

(2021-05-14)

Fixed

  • Fixed the issue with not displayed selected store in tag form if 'All Store Views' selected

1.1.1

(2021-04-29)

Fixed

  • Magento EE PageBuilder compatibility

1.1.0

(2021-04-27)

Features

  • Ability to manage Authors
  • Ability to manage Tags
  • Full multistore support (Posts, Categories, Authors, Tags)
  • Different display modes for post and post list pages
  • New widgets (2 types, old widgets will be removed)
  • Ability to duplicate posts
  • Open Graph meta tags for posts (generated automatically)

1.0.6

(2021-02-15)

Fixed

  • rss
  • save post without date

1.0.5

(2021-01-19)

Fixed

  • Minor fixes

1.0.4

(2021-01-16)

Fixed

  • Issue with templates

1.0.3

(2020-12-31)

Fixed

  • Stored "Store View" does not show in the form (m2.4.1)

1.0.2

(2020-12-30)

Fixed

  • Error "Type Error occurred when creating object: Mirasvit\BlogMx\Block\Catalog\RelatedPosts ..."
  • Error "TypeError: Return value of Mirasvit\BlogMx\Model\ConfigProvider::getCommentProvider() ..."

1.0.1

(2020-12-18)

Fixed

  • Minor fixes

1.0.0

(2020-12-11)

Features

  • Initial release