Cleanup duplicate README docs and update documentation links (#100)

delucis · Mar 30, 2024 · 39e3d16 · 39e3d16
1 parent 2ad70ec
commit 39e3d16
Show file tree

Hide file tree

Showing 16 changed files with 52 additions and 290 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -10,5 +10,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": []
+  "ignore": ["@astro-community/astro-embed-demo", "@astro-community/astro-embed-docs"]
 }
diff --git a/.changeset/metal-clouds-vanish.md b/.changeset/metal-clouds-vanish.md
@@ -0,0 +1,9 @@
+---
+'@astro-community/astro-embed-integration': patch
+'@astro-community/astro-embed-twitter': patch
+'@astro-community/astro-embed-youtube': patch
+'@astro-community/astro-embed-vimeo': patch
+'astro-embed': patch
+---
+
+Simplifies README.md to link to docs site
diff --git a/.changeset/twenty-humans-nail.md b/.changeset/twenty-humans-nail.md
@@ -0,0 +1,9 @@
+---
+'@astro-community/astro-embed-integration': patch
+'@astro-community/astro-embed-twitter': patch
+'@astro-community/astro-embed-youtube': patch
+'@astro-community/astro-embed-vimeo': patch
+'astro-embed': patch
+---
+
+Updates documentation links in `package.json`
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Welcome! This project aims to collect easy-to-use and lightweight ways to embed
 
 Want to get started using some embed components?
 
-[Check out the README for the `astro-embed` package ](packages/astro-embed/README.md)
+Check out the [`astro-embed` documentation](https://astro-embed.netlify.app/)
 
 ## 🚀 Project Structure
 

diff --git a/docs/package.json b/docs/package.json
@@ -1,7 +1,8 @@
 {
-  "name": "docs",
+  "name": "@astro-community/astro-embed-docs",
   "type": "module",
   "version": "0.0.1",
+  "private": true,
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/astro-embed-integration/README.md b/packages/astro-embed-integration/README.md
@@ -1,33 +1,5 @@
 # @astro-community/astro-embed-integration
 
-This is an experimental Astro integration that allows you to auto-convert URLs in MDX files to a corresponding embed component.
+This is an Astro integration that allows you to auto-convert URLs in MDX files to corresponding embed components.
 
-## Install
-
-```bash
-npm i @astro-community/astro-embed-integration
-```
-
-## Usage
-
-To enable the integration, add it to the `integrations` array in your `astro.config.mjs` file:
-
-```js
-import { defineConfig } from 'astro/config';
-import mdx from '@astrojs/mdx';
-import embeds from '@astro-community/astro-embed-integration';
-
-export default defineConfig({
-  integrations: [embeds(), mdx()],
-});
-```
-
-With the integration enabled, any isolated URL in an MDX file that matches one of the `astro-embed` component types will be converted to the appropriate component.
-
-For example, MDX like this will render an optimised YouTube player component in place of the URL.
-
-```mdx
-I saw this cool video the other day:
-
-http://www.youtube.com/watch?v=Hoe-woAhq_k
-```
+[See the docs for usage instructions](https://astro-embed.netlify.app/getting-started/#auto-embed-urls-in-mdx).
diff --git a/packages/astro-embed-integration/package.json b/packages/astro-embed-integration/package.json
@@ -12,14 +12,15 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/delucis/astro-embed.git"
+    "url": "https://github.com/delucis/astro-embed",
+    "directory": "packages/astro-embed-integration"
   },
   "author": "delucis",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/delucis/astro-embed/issues"
   },
-  "homepage": "https://github.com/delucis/astro-embed/tree/main/packages/astro-embed-integration#readme",
+  "homepage": "https://astro-embed.netlify.app/getting-started/#auto-embed-urls-in-mdx",
   "dependencies": {
     "@astro-community/astro-embed-twitter": "^0.5.3",
     "@astro-community/astro-embed-vimeo": "^0.3.2",

diff --git a/packages/astro-embed-twitter/README.md b/packages/astro-embed-twitter/README.md
@@ -2,53 +2,4 @@
 
 This package contains a component for embedding tweets in Astro projects.
 
-## Install
-
-```bash
-npm i @astro-community/astro-embed-twitter
-```
-
-## Usage
-
-### `<Tweet id={tweetUrl} />`
-
-The **Tweet** component generates a static Twitter card for a single Tweet using [Twitter’s oEmbed API](https://developer.twitter.com/en/docs/twitter-for-websites/oembed-api).
-
-```astro
----
-import { Tweet } from '@astro-community/astro-embed-twitter';
----
-
-<Tweet id="https://twitter.com/astrodotbuild/status/1511750228428435457" />
-```
-
-### Loading Twitter’s JavaScript
-
-By design, this is a minimal component and loads zero JavaScript, only rendering some static HTML content.
-However, this HTML is compatible with Twitter’s widget system.
-Loading Twitter‘s large bundle of widget JavaScript will convert each `<Tweet />` into an interactive embed.
-
-You can do this by including a `<script>` tag in your Astro layout file:
-
-```html
-<script async src="https://platform.twitter.com/widgets.js"></script>
-```
-
-### Styling
-
-By default the card has minimal styling, which should adapt to your site’s font settings etc.
-
-You can customise it by targeting the `.twitter-tweet` class, for example:
-
-```css
-.twitter-tweet {
-  background: floralwhite;
-  font-family: sans-serif;
-  border: 0;
-}
-
-.twitter-tweet a {
-  color: purple;
-  font-weight: bold;
-}
-```
+[Read the `<Tweet>` component docs](https://astro-embed.netlify.app/components/twitter/).
diff --git a/packages/astro-embed-twitter/package.json b/packages/astro-embed-twitter/package.json
@@ -15,7 +15,8 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/delucis/astro-embed.git"
+    "url": "https://github.com/delucis/astro-embed",
+    "directory": "packages/astro-embed-twitter"
   },
   "keywords": [
     "astro",
@@ -28,11 +29,11 @@
   "bugs": {
     "url": "https://github.com/delucis/astro-embed/issues"
   },
-  "homepage": "https://github.com/delucis/astro-embed/tree/main/packages/astro-embed-twitter#readme",
+  "homepage": "https://astro-embed.netlify.app/components/twitter/",
   "dependencies": {
     "@astro-community/astro-embed-utils": "^0.1.0"
   },
   "peerDependencies": {
     "astro": "^2.0.0 || ^3.0.0-beta || ^4.0.0-beta"
   }
-}
+}
diff --git a/packages/astro-embed-vimeo/README.md b/packages/astro-embed-vimeo/README.md
@@ -2,58 +2,4 @@
 
 This package contains a component for embedding Vimeo videos in Astro projects.
 
-## Install
-
-```bash
-npm i @astro-community/astro-embed-vimeo
-```
-
-## Usage
-
-### `<Vimeo id={video_id_or_url} />`
-
-The **Vimeo** component generates an embed using a `lite-vimeo` custom element. Vimeo embeds will always require some JavaScript, but this is one of the most minimal and performant ways to embed a Vimeo video.
-
-```astro
----
-import { Vimeo } from '@astro-community/astro-embed-vimeo';
----
-
-<Vimeo id="32001208" />
-```
-
-You can also pass in the full URL for the video:
-
-```astro
-<Vimeo id="https://vimeo.com/32001208" />
-```
-
-#### Optional props
-
-##### `poster`
-
-You can provide an alternative poster image by passing in a URL to the `poster` prop.
-
-```astro
-<Vimeo
-  id="32001208"
-  poster="https://images-assets.nasa.gov/image/0302063/0302063~orig.jpg"
-/>
-```
-
-##### `params`
-
-You can pass a `params` prop to set the [player parameters supported by Vimeo](https://vimeo.zendesk.com/hc/en-us/articles/360001494447-Player-parameters-overview). This looks like a series of URL search params.
-
-```astro
-<!-- Example: Set the UI color to red and mute by default. -->
-<Vimeo id="32001208" params="color=ff0000&muted=1" />
-```
-
-##### `playlabel`
-
-By default, the play button in the embed has an accessible label set to “Play”. If you want to customise this, you can set the `playlabel` prop.
-
-```astro
-<Vimeo id="32001208" playlabel="Play the video" />
-```
+[Read the `<Vimeo>` component docs](https://astro-embed.netlify.app/components/vimeo/).
diff --git a/packages/astro-embed-vimeo/package.json b/packages/astro-embed-vimeo/package.json
@@ -15,7 +15,8 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/delucis/astro-embed.git"
+    "url": "https://github.com/delucis/astro-embed",
+    "directory": "packages/astro-embed-vimeo"
   },
   "keywords": [
     "astro",
@@ -28,8 +29,8 @@
   "bugs": {
     "url": "https://github.com/delucis/astro-embed/issues"
   },
-  "homepage": "https://github.com/delucis/astro-embed/tree/main/packages/astro-embed-vimeo#readme",
+  "homepage": "https://astro-embed.netlify.app/components/vimeo/",
   "peerDependencies": {
     "astro": "^2.0.0 || ^3.0.0-beta || ^4.0.0-beta"
   }
-}
+}
diff --git a/packages/astro-embed-youtube/README.md b/packages/astro-embed-youtube/README.md
@@ -2,57 +2,4 @@
 
 This package contains a component for embedding YouTube videos in Astro projects.
 
-## Install
-
-```bash
-npm i @astro-community/astro-embed-youtube
-```
-
-## Usage
-
-### `<YouTube id={video_id} />`
-
-The **YouTube** component generates an embed using [the `lite-youtube-embed` custom element](https://github.com/paulirish/lite-youtube-embed). YouTube embeds will always require some JavaScript, but this is one of the most minimal and performant ways to embed a YouTube video.
-
-```astro
----
-import { YouTube } from '@astro-community/astro-embed-youtube';
----
-
-<YouTube id="xtTy5nKay_Y" />
-```
-
-You can also pass in a URL in one of the various YouTube formats.
-
-```astro
-<YouTube id="https://youtu.be/xtTy5nKay_Y" />
-```
-
-#### Optional props
-
-##### `poster`
-
-You can provide an alternative poster image by passing in a URL to the `poster` prop.
-
-```astro
-<YouTube
-  id="xtTy5nKay_Y"
-  poster="https://images-assets.nasa.gov/image/0302063/0302063~orig.jpg"
-/>
-```
-
-##### `params`
-
-As when using `lite-youtube-embed` directly, you can pass in a `params` prop to set the [YouTube player parameters](https://developers.google.com/youtube/player_parameters#Parameters). This looks like a series of URL search params.
-
-```astro
-<YouTube id="xtTy5nKay_Y" params="start=10&end=30" />
-```
-
-##### `playlabel`
-
-By default, the play button in the embed has an accessible label set to “Play”. If you want to customise this, you can set the `playlabel` prop.
-
-```astro
-<YouTube id="xtTy5nKay_Y" playlabel="Play the video" />
-```
+[Read the `<YouTube>` component docs](https://astro-embed.netlify.app/components/youtube/).
diff --git a/packages/astro-embed-youtube/package.json b/packages/astro-embed-youtube/package.json
@@ -14,7 +14,8 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/delucis/astro-embed.git"
+    "url": "https://github.com/delucis/astro-embed",
+    "directory": "packages/astro-embed-youtube"
   },
   "keywords": [
     "astro",
@@ -27,7 +28,7 @@
   "bugs": {
     "url": "https://github.com/delucis/astro-embed/issues"
   },
-  "homepage": "https://github.com/delucis/astro-embed/tree/main/packages/astro-embed-youtube#readme",
+  "homepage": "https://astro-embed.netlify.app/components/youtube/",
   "dependencies": {
     "lite-youtube-embed": "^0.3.2"
   },