search

cliffordp / mdl-shortcodes

This plugin is no longer maintained or supported. Google is no longer maintaining MDL.
https://wordpress.org/plugins/mdl-shortcodes/
GNU General Public License v3.0
3 stars 1 forks source link

readme

=== MDL Shortcodes === Contributors: cliffpaulick Tags: mdl, material design lite, google, shortcode, shortcodes Donate link: http://tourkick.com/pay/ Requires at least: 4.0 Tested up to: 4.3.1 Stable tag: trunk License: GPLv3 License URI: https://www.gnu.org/licenses/gpl.html

This plugin is no longer maintained or supported. Google is no longer maintaining MDL.

== Description ==

From Google MDL Staff:

MDL is no longer being maintained by the core team so much. We are focusing on Material Components for Web (previously MDLv2) and MDL is primarily up to community members to handle at this point.

===

Making it easy to use Google's Material Design Lite (MDL) components in WordPress via shortcodes. MDL components are viewable at http://www.getmdl.io/components/

Integrates with Shortcake (Shortcode UI) so building shortcodes (even ones with complex options) is super easy!

Loads the 3 required files -- Icon Font (0.6 kB), CSS (18.2 kB), and JS (10.3 kB) totaling approximately 29.1 kB (or 0.028 MB) -- on every page load, so feel free to use the MDL Shortcodes (or even your own custom MDL styling) anywhere throughout your site.

There will be a plugin update each time there is a new MDL Release.

= Highlights =

= Complimentary Plugins = These plugins may come in handy when building or customizing a site with MDL Shortcodes: (may contain affiliate links)

= Acknowledgements = Special thanks to:

= Support Me =

== Installation ==

After automatically installing to wp-content/plugins/:

  1. Install the Shortcake (Shortcode UI) plugin (you'll be prompted to do so if it's not already installed and activated). It's optional but highly recommended.
  2. Click the "MDL Shortcodes Options" wp-admin menu item (next to "Appearance" menu item) to select your MDL colors.
  3. Then just use the shortcodes in any Visual Editor (e.g. Post/Page edit screens). With Shortcake (Shortcode UI) plugin activated you'll be able to click "Add Media" then "Insert Post Element" then select one of the shortcodes to customize.

== Frequently Asked Questions == What shortcodes are available?

What are some shortcode examples?

When you install and activate the MDL Shortcodes plugin, a new Page will be created. It will be titled "MDL Shortcodes Plugin Demo Examples" and is only a Draft, not Published. You can click in to edit this page; go to the Text Editor (not Visual Editor) to see the shortcodes in use. Note that this will be the page you preview when clicking the "MDL Shortcodes Options" wp-admin menu link to pick your CSS colors.

For universal reference, here are some shortcode examples:

Don't forget most of these shortcodes have a user interface (UI) to make it easy to create them (so you don't have to manually enter all that shortcode garbly-gook).

These components will be styled as seen at http://www.getmdl.io/components/ unless customized.

Does MDL Shortcodes work with my theme?

The styling of all these components is essentially self-contained. Due to the nature of implementing the shortcodes (they require the Icon Font, CSS, and JS files to be loaded), this plugin can feel like it "takes over" your theme's styling. In summary, yes, it should WORK with your theme (not cause PHP or other errors), but it may not LOOK GREAT with your theme (although that doesn't mean it can't with some tweaks).

How can I override the Roboto font being used everywhere?

This comes from the MDL stylesheet (CSS). It can be easily overridden via Easy Google Fonts.

Can I use my own version of the CSS (e.g. Sass)?

Yup. There are a few filters for that.

Why does this plugin add the MDL styling to the wp-admin area?

In order to render shortcode previews in the TinyMCE Visual Editor, the 3 MDL files are loaded whenever there's a TinyMCE Visual Editor present. This obviously happens on Page/Post Editing screens, but it can also happen elsewhere in wp-admin. It shouldn't be causing any issues other than styling inconsistencies among wp-admin screens.

== Screenshots ==

  1. MDL Shortcodes settings in the WordPress Customizer. Get there by clicking the "MDL Shortcodes Options" wp-admin menu item (next to "Appearance" menu item).

  2. Shortcodes render in the wp-admin Visual Editor when Shortcake (Shortcode UI) plugin is active.

  3. With Shortcake (Shortcode UI) plugin activated you'll be able to click "Add Media" then "Insert Post Element" then select one of the shortcodes to customize.

  4. Example Shortcake (Shortcode UI) interface for building a MDL Button shortcode.

  5. Front-end example: MDL Icon, MDL Badge, MDL Button

  6. Front-end example: MDL Card pulling in post info (blurred out) and MDL Card with manually-entered text.

  7. Front-end example: MDL Grids and MDL Cells

  8. Front-end example: MDL Tabs

  9. Front-end example: MDL Menu

  10. Front-end example: MDL Tooltip

== Changelog == Changelog DIFFs for all versions are available at WordPress SVN. MDL Releases are viewable at github.com/google/material-design-lite/releases

= Version 1.0.3 =

= Version 1.0.2 =

= Version 1.0.1 =

= Version 1.0 =