https://github.com/chemiker/e.nigma-buttons
e.nigma buttons is a WordPress plugin that easily allows you to add buttons to your posts, pages etc.
https://github.com/chemiker/e.nigma-buttons
shortcode wordpress wordpress-plugin
Last synced: about 2 months ago
JSON representation
e.nigma buttons is a WordPress plugin that easily allows you to add buttons to your posts, pages etc.
- Host: GitHub
- URL: https://github.com/chemiker/e.nigma-buttons
- Owner: chemiker
- License: other
- Created: 2014-12-20T15:08:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-09-04T21:01:54.000Z (almost 6 years ago)
- Last Synced: 2024-04-14T06:12:52.287Z (about 2 years ago)
- Topics: shortcode, wordpress, wordpress-plugin
- Language: Shell
- Homepage: https://sciolism.de/projects/e.nigma-buttons/
- Size: 963 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
# e.nigma buttons
*e.nigma buttons* is a WordPress plugin that easily allows you to add buttons to your posts, pages etc.
[](https://codeclimate.com/github/chemiker/e.nigma-buttons/maintainability) [](https://travis-ci.com/chemiker/e.nigma-buttons)
## Shortcodes & Attributes
*e.nigma buttons* adds the shortcode `[button]` to your installation. The following options can be used to adjust the button for your needs:
* `label`: The label of your button
* `icon`: The icon of your button
* `link`: The link of your button
* `color`: The color of button
* `border`: yes (default) or no
* `size`: small, medium (default) or large
* `class`: Additional CSS classes that will be added to your buttons icon
### Colors
The following colors are avaible:
* green
* orange
* purple
* cyan
* white
* red
* black
### Icons
*e.nigma buttons* uses [Font Awesome](http://fontawesome.io/) as icon resource. [An overview over all available icons](http://fontawesome.io/icons/) can be found on their website.
## Usage
Most of the shortcodes attributes are self explaining. However, it must be noted that the `icon` attribute can be filled by using modififed [Font Awesome shortcodes](http://fontawesome.io/icons/).
For instance: If you want to use the GitHub icon you would search for that icon in the [list of all icons](http://fontawesome.io/icons/). What you will find is the corresponding CSS class. For *e.nigma buttons* the name of the icon (which is obtained if stripping the "fa-" in the beginning of the CSS class) is used. For GitHub the CSS class would be `fa-github`. Thus, `github` is your value for the `icon` attribute.
### Examples
`[button label="My GitHub account" icon="github" color="orange" link="https://github.com/chemiker"]`
Brings you an linked, medium-sized, orange button that has a GitHub icon and the label "My GitHub account".
`[button icon="github" color="orange" link="https://github.com/chemiker" size="large"]`
Brings you an orange, large-sized, linked GitHub icon.
## FAQ
See the FAQ in the repository [Wiki](https://github.com/chemiker/enigma-buttons/wiki).
## License & copyright
This project is released under the MIT license.
### Icons / Fonts
The plugin uses [Font Awesome](http://fontawesome.io) icons which is a project by Dave Gandy. Font Awesome fonts (Copyright by Dave Gandy) are released under [SIL OFL 1.1](http://scripts.sil.org/OFL). Font Awesome CSS files (shipped as part of this plugin's CSS file) by Dave Gandy are released under [MIT license](https://opensource.org/licenses/MIT).
### Tests
This repository ships with tests. The tests are based on ["sample-plugin"](https://github.com/wp-cli/sample-plugin). The following files are part of the package which is released under GPLv2 (Copyright by Daniel Bachhuber) and have been modified:
* test/*
* bin/*
* .travis.yml
* phpcs.xml.dist
* phpunit.xml.dist
## Development
As the plugin this is real free software you are very welcome to fork this project and do whatever you want with it :)
### Requirements
* yarn
### Installation
1. Download the zip archive or clone the repository to your WordPress plugin directory
2. run `yarn install`
4. run `yarn run gulp dev` to continuously watch the (CSS/PHP) files and compile them if necessary
For distribution you can run `yarn run gulp make`. This will create a `dist/` folder ready for submission to the WordPress.org repository.