mirror/mastodon-embed-timeline
1
0
Fork 1
mirror of https://gitlab.com/idotj/mastodon-embed-timeline.git synced 2025-05-23 08:29:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
mastodon-embed-timeline/docs/INSTALLATION.md
i.j 72751a25cb V4.5.0
2025-03-01 13:06:28 +00:00

1.9 KiB
Raw Blame History

🐘 Mastodon embed timeline - 🛠️ Installation

You have three different ways to install it in your project:

Download

Download and copy these two files into your project folder:

  • dist/mastodon-timeline.min.css
  • dist/mastodon-timeline.umd.js

Load the CSS and JS files in your HTML page using the <link> and <script> tags as follows in this example:

<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Example of site title</title>
    <!-- Your CSS -->
    <link href="your/path/to/file/mastodon-timeline.min.css" rel="stylesheet" />
  </head>

  <body>
    <!-- HTML content -->
    ...

    <!-- Your JavaScript -->
    <script src="your/path/to/file/mastodon-timeline.umd.js"></script>
    <script>
      // You can initialize the script here
    </script>
  </body>
</html>

CDN

This option allows you to start without the need to upload any files on your server.
Copy the following CSS and JS links to include them in your project:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@idotj/mastodon-embed-timeline@4.5.0/dist/mastodon-timeline.min.css" crossorigin="anonymous">

<script src="https://cdn.jsdelivr.net/npm/@idotj/mastodon-embed-timeline@4.5.0/dist/mastodon-timeline.umd.js" crossorigin="anonymous"></script>

Package manager

A quick way to get it installed using npm or yarn:

npm install @idotj/mastodon-embed-timeline

or

yarn add @idotj/mastodon-embed-timeline

After installation, you can import it as follows:

import * as MastodonTimeline from "@idotj/mastodon-embed-timeline";

Make sure to import also the file mastodon-timeline.min.css into your project.