1
0
mirror of https://github.com/NickKaramoff/shareon synced 2025-03-18 12:20:11 +01:00
2024-11-23 09:19:33 +01:00

308 lines
9.2 KiB
HTML
Executable File
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en-GB">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Shareon Lightweight, stylish, and ethical share buttons</title>
<meta
name="title"
content="Shareon Lightweight, stylish, and ethical share buttons"
/>
<meta
name="description"
content="Theyre 7.5 kB in size, look good, and don't track your users. It's the perfect choice for your blog, news site, or project page!"
/>
<meta
name="keywords"
content="share buttons, sharing, social networks, share via, share on"
/>
<meta name="author" content="Nikita Karamov" />
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/awsm.css/dist/awsm.min.css"
/>
<link
href="https://cdn.jsdelivr.net/npm/shareon@2.6/dist/shareon.min.css"
rel="stylesheet"
/>
<script
src="https://cdn.jsdelivr.net/npm/shareon@2.6/dist/shareon.iife.js"
defer
init
></script>
<!-- fixes for awsm.css -->
<style>
.shareon.specimen {
font-weight: bold;
max-width: 500px;
margin: 0 auto;
}
.shareon > a,
.shareon > a:hover,
.shareon > a:visited {
color: #fff;
}
button:not([disabled]):hover {
border: none;
}
</style>
<link rel="icon" href="/favicon.ico" sizes="any" />
<link rel="icon" href="/icon.svg" type="image/svg+xml" />
<link rel="apple-touch-icon" href="/apple-touch-icon.png" />
<link rel="manifest" href="/site.webmanifest" />
<!-- Open Graph / Facebook -->
<meta property="og:type" content="website" />
<meta property="og:url" content="https://shareon.js.org/" />
<meta
property="og:title"
content="Shareon Lightweight, stylish, and ethical share buttons"
/>
<meta
property="og:description"
content="Theyre 7.5 kB in size, look good, and don't track your users. It's the perfect choice for your blog, news site, or project page!"
/>
<meta property="og:image" content="https://shareon.js.org/banner.png" />
<!-- Twitter -->
<meta property="twitter:card" content="summary_large_image" />
<meta property="twitter:url" content="https://shareon.js.org/" />
<meta
property="twitter:title"
content="Shareon Lightweight, stylish, and ethical share buttons"
/>
<meta
property="twitter:description"
content="Theyre under 7.5 kB in size, look good, and don't track your users. It's the perfect choice for your blog, news site, or project page!"
/>
<meta
property="twitter:image"
content="https://shareon.js.org/banner.png"
/>
<meta name="twitter:creator" content="@KyttaWasHere" />
</head>
<body>
<header>
<p>
<img
src="./icon.svg"
alt="Shareon logo — the Postal Horn emoji"
width="64"
height="64"
/>
</p>
<h1>Shareon</h1>
<p>Lightweight, stylish, and ethical share buttons</p>
<nav>
<ul>
<li>
<a href="https://www.npmjs.com/package/shareon">npm</a>
</li>
<li>
<a href="https://github.com/kytta/shareon">source code</a>
</li>
</ul>
</nav>
</header>
<main>
<article>
<h2>
<a id="what-is-it" href="#what-is-it" aria-hidden="true"></a>
What is it?
</h2>
<p>Shareon are share buttons for popular social networks.</p>
<div
class="shareon specimen"
data-title="Shareon — lightweight, stylish, and ethical share buttons"
style="text-align: center"
>
<a class="bluesky"></a>
<a class="facebook">Share</a>
<a class="fediverse"></a>
<a class="hackernews"></a>
<a class="linkedin"></a>
<a class="mastodon">Toot</a>
<a class="messenger" data-fb-app-id="3619024578167617"></a>
<a class="odnoklassniki"></a>
<br />
<a class="pinterest">Pin</a>
<a class="pocket"></a>
<a class="reddit"></a>
<a class="teams"></a>
<a class="telegram">Send</a>
<a class="tumblr"></a>
<a class="twitter"></a>
<a class="viber"></a>
<br />
<a class="vkontakte">Поделиться</a>
<a class="whatsapp"></a>
<a class="copy-url"></a>
<a class="email"></a>
<a class="print">Print</a>
<a class="web-share"></a>
</div>
<p>Unlike many other share buttons, Shareon are:</p>
<ul>
<li>
<b>lightweight</b>, clocking in at only 7.5 kB brotlied code (JS+CSS),
</li>
<li>
<b>stylish</b>, using official vector logos and colours with no
visual mess, and
</li>
<li>
<b>ethical</b>, since they do not insert any pesky tracking code.
</li>
</ul>
<p>
The whole JavaScript code is quick and simple: it only populates the
buttons with share links. This makes Shareon the perfect choice for
your blog, news site, or project page!
</p>
</article>
<article>
<h2>
<a id="install" href="#install" aria-hidden="true"></a>
Install
</h2>
<p>Simply load the needed files from the CDN:</p>
<pre><code>&lt;link
href="https://cdn.jsdelivr.net/npm/shareon@2/dist/shareon.min.css"
rel="stylesheet"
&gt;
&lt;script
src="https://cdn.jsdelivr.net/npm/shareon@2/dist/shareon.iife.js"
defer
init
&gt;&lt;/script&gt;</code></pre>
<aside>
<p>
Want other options? Check the
<a href="https://github.com/kytta/shareon/#install"
>extended docs</a
>
on GitHub!
</p>
</aside>
<p>or install it via NPM and bundle it in a JS file:</p>
<pre><code>import * as Shareon from "shareon";
import "shareon/css";
Shareon.init();</code></pre>
</article>
<article>
<h2>
<a id="usage" href="#usage" aria-hidden="true"></a>
Usage
</h2>
<p>
Create a container with class <code>shareon</code> and populate it
with elements, class names of which match the names of the social
networks:
</p>
<pre><code>&lt;div class="shareon"&gt;
&lt;a class="bluesky"&gt;&lt;/a&gt;
&lt;a class="facebook"&gt;&lt;/a&gt;
&lt;a class="fediverse"&gt;&lt;/a&gt;
&lt;a class="hackernews"&gt;&lt;/a&gt;
&lt;a class="linkedin"&gt;&lt;/a&gt;
&lt;a class="mastodon"&gt;&lt;/a&gt;
&lt;!-- FB App ID is required for the Messenger button to function --&gt;
&lt;a class="messenger" data-fb-app-id="0123456789012345"&gt;&lt;/a&gt;
&lt;a class="odnoklassniki"&gt;&lt;/a&gt;
&lt;a class="pinterest"&gt;&lt;/a&gt;
&lt;a class="pocket"&gt;&lt;/a&gt;
&lt;a class="reddit"&gt;&lt;/a&gt;
&lt;a class="teams"&gt;&lt;/a&gt;
&lt;a class="telegram"&gt;&lt;/a&gt;
&lt;a class="tumblr"&gt;&lt;/a&gt;
&lt;a class="twitter"&gt;&lt;/a&gt;
&lt;a class="viber"&gt;&lt;/a&gt;
&lt;a class="vkontakte"&gt;&lt;/a&gt;
&lt;a class="whatsapp"&gt;&lt;/a&gt;
&lt;a class="copy-url"&gt;&lt;/a&gt;
&lt;a class="email"&gt;&lt;/a&gt;
&lt;a class="print"&gt;&lt;/a&gt;
&lt;!-- Does not work in every browser --&gt;
&lt;a class="web-share"&gt;&lt;/a&gt;
&lt;/div&gt;</code></pre>
<div class="shareon">
<a class="bluesky"></a>
<a class="facebook"></a>
<a class="fediverse"></a>
<a class="hackernews"></a>
<a class="linkedin"></a>
<a class="mastodon"></a>
<a class="messenger" data-fb-app-id="3619024578167617"></a>
<a class="odnoklassniki"></a>
<a class="pinterest"></a>
<a class="pocket"></a>
<a class="reddit"></a>
<a class="teams"></a>
<a class="telegram"></a>
<a class="tumblr"></a>
<a class="twitter"></a>
<a class="viber"></a>
<a class="vkontakte"></a>
<a class="whatsapp"></a>
<a class="copy-url"></a>
<a class="email"></a>
<a class="print"></a>
<a class="web-share"></a>
</div>
<p>
You can customize the shared URL and page title with
<code>data-</code> attributes:
</p>
<pre><code>&lt;div class="shareon" data-url="https://custom.url/for-this-page"&gt;
&lt;a class="facebook" data-title="Custom Facebook title"&gt;&lt;/a&gt;
&lt;a class="twitter" data-title="Custom Twitter title"&gt;&lt;/a&gt;
&lt;/div&gt;</code></pre>
<p>
Read more in the
<a href="https://github.com/kytta/shareon/#usage">README</a>
on GitHub!
</p>
</article>
</main>
<footer>
<p>
Copyright © 20202024
<a href="https://www.kytta.dev/">Nikita Karamov</a>
<br />
Licenced under the MIT License.
</p>
<p>
Website built with
<a href="https://igoradamenko.github.io/awsm.css/index.html"
>awsm.css</a
>
</p>
</footer>
</body>
</html>