Installation

Direct <script> Include

Simply download and include with a script tag. MakerLink will be registered as a global variable. Download the latest release tarball directly from maker-link.js releases.

CDN

Coming soon!

npm

npm is the recommended installation method.

# latest stable
$ npm install maker-link

Bower

Coming soon!

Yarn

Coming soon!

Introduction

What is maker-links.js?

maker-links.js is a JavaScript-only port of Pieter Levels' Maker Links. Created by Cedric Amaya, this library aims to simplify the process of adding Maker Links to a website by getting rid of the need to write additional HTML and CSS, and instead only instantiate a simple JavaScript object.

Getting Started

The official guide assumes basic level knowledge of HTML, CSS, and JavaScript. If you are totally new to frontend development, it is strongly encouraged you take a look at the cited references (typically MDN web development documentation).

The easiest way to try out maker-link.js is using the official Generator which allows you to customize a Maker Link in real-time. Otherwise, follow one of the Installation steps and continue reading.

Setup

Instantiate a new MakerLink object with options containing your information to have a Maker Link automatically added to your site.

<!-- index.html -->

<!-- Include the MakerLink library -->
<script src="path/to/maker-link.js/"></script>

<!-- Initialize MakerLink object -->
<script>
const makerLink = new MakerLink({
  author: "cedric amaya",
  photoURL: "https://pbs.twimg.com/profile_images/1002035724076568576/8SSEXKp3_400x400.jpg",
  redirectURL: "https://cedric.tech",
  brandColor: '#007bff',
  font: 'monospace',
  });
</script>

Customization

Customization of the Maker Link is controlled by the options passed to the MakerLink constructor. See below for more information about the specific properties of the options object.

author

Type: String

Default: 'levelsio'

Text to display inside the Maker Link. Typically your name or social-media handle.

photoURL

Type: String

Default: 'https://levels.io/levelsio.png'

URL pointing to the image you'd like displayed in the Maker Link.

If an empty string ('') is given, then the Maker Link will hide the<img> element (by applying display: none).

redirectURL

Type: String

Default: 'https://levels.io/'

URL pointing to the link you want users to visit when the Maker Link is clicked.

brandColor

Type: String

Default: 'rgb(255, 71, 66)'

String containing valid CSS representing the CSS color property. Applied to the display text when hovered.

More Information: MDN color CSS property

font

Type: String

Default: '"Helvetica Neue", sans-serif'

String containing valid CSS representing the CSS font-family property. Any font that your site has access to is fair game for the Maker Link font option as well.

More Information: MDN font-family CSS property

How to Contribute

Contributions are welcome from anyone and everyone.

Steps for Contributing

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

Note: Be sure to merge the latest from "upstream" before making a pull request!

Open Development

All work on maker-link.js happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

Semantic Versioning

maker-link.js follows semantic versioning. We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.

Bugs

Where to Find Known Issues

We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.

Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case.

Contributors

Special thanks to those who have helped maker-link.js:

• Cedric Amaya (@CedricAmaya)

Licenses

maker-link.js Logo

"impossible shape" by Rflor from The Noun Project.

Landing Page Link Graphic

"SEO Marketing Icon Set, Link" by Lukasz Adam from Lukasz Adam under the MIT License.

Bulma

The MIT License (MIT)

Copyright (c) 2018 Jeremy Thomas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Underscore

Copyright (c) 2009-2018 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.