Install

Getting Started!

Viewing gitmbed Content

1. After installing, the gitmbed browser extension will begin searching for embbeded content. When it finds this, it will automatically render it.

Making gitmbed Content

Auto-Generation (most users)

1. Navigate to https://gitmbed.finnsoftware.net#setup.
2. Fill-out the form with the correct data: url, width, and height
3. Your code will show up in the textarea below the form inputs. Copy this, and paste anywhere. Anyone with the gitmbed extension will be able to view your embedded content!
4. That's it! Congrats on the setup! 🎉

Manual Setup

1. The bare-minimum for gitmbed content is that it contains the page contains an image element () with the HTML alt attribute. Inside this alt, you must append the arguments embed src, embed width, embed height
2. As stated on the gitmbed homepage, the embed_width and embed_height arguments can take either a numerical px, percent, em, or rem value. It should also be noted that the embed_url must be a full url, including https://, http://, or file://

Example

The code for the below example looks like the following (will show-up as "Download Extension to View", unless extension is downloaded, where it will be an embed to my latest sheet music 🎵):

<img alt="gitmbed=https://musescore.com/user/35848526/scores/6907224/embed,100%,500" width="100%" src="https://gitmbed.finnsoftware.net/assets/img/button_gitmbed.png"/>

License

Gitmbed, it's content, and it's ideas are copyrighted under the Apache 2.0 License. Details on this license, your rights, and the rights of the copyright holder can be found here

The GitHub Primer.css is under MIT License.

The MIT License (MIT)

Copyright (c) 2021 GitHub Inc.

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.