| 1 | # microsite
|
| 2 |
|
| 3 | ## 0.6.1
|
| 4 |
|
| 5 | ### Patch Changes
|
| 6 |
|
| 7 | - a3a5131: Fix external warning
|
| 8 | - 5c79ec3: update README
|
| 9 |
|
| 10 | ## 0.6.0
|
| 11 |
|
| 12 | ### Breaking Changes
|
| 13 |
|
| 14 | - 9d0e9cc: Drop `@types/react` and switch to `preact`. See issue [#5](https://github.com/natemoo-re/microsite/issues/5) for more background.
|
| 15 |
|
| 16 | ## 0.0.0-canary-2020101419274
|
| 17 |
|
| 18 | ### Breaking Changes
|
| 19 |
|
| 20 | - 7fd4679: Drop `@types/react` and switch to `preact`. See issue [#5](https://github.com/natemoo-re/microsite/issues/5) for more background.
|
| 21 |
|
| 22 | ## 0.5.1
|
| 23 |
|
| 24 | ### Patch Changes
|
| 25 |
|
| 26 | - 3d99331: Fix handling of node builtins for intermediate builds
|
| 27 | - 3d99331: Remove .microsite/cache dir for now
|
| 28 |
|
| 29 | ## 0.5.1-next.0
|
| 30 |
|
| 31 | ### Patch Changes
|
| 32 |
|
| 33 | - a29b71e: Fix handling of node builtins for intermediate builds
|
| 34 | - 078b910: Remove .microsite/cache dir for now
|
| 35 |
|
| 36 | ## 0.5.0
|
| 37 |
|
| 38 | ### Minor Changes
|
| 39 |
|
| 40 | - 47eec22: **Build performance improvements**
|
| 41 |
|
| 42 | Rather than relying on [`@rollup/plugin-typescript`](https://github.com/rollup/plugins/tree/master/packages/typescript) (which uses `typescript` under the hood), we have switched to [`rollup-plugin-esbuild`](https://github.com/egoist/rollup-plugin-esbuild) to perform code transforms.
|
| 43 |
|
| 44 | [`esbuild`](https://github.com/evanw/esbuild) is very very fast. Now, so is Microsite.
|
| 45 |
|
| 46 | ### Patch Changes
|
| 47 |
|
| 48 | - 275f297: Gracefully handle Component/export name mismatch
|
| 49 |
|
| 50 | Automatically handle `tsconfig.paths` aliases
|
| 51 |
|
| 52 | - 945685d: **SEO**
|
| 53 |
|
| 54 | Microsite aims to make SEO as simple as possible, so this featureset adds built-in SEO utility components to `microsite/head` under the `seo` namespace.
|
| 55 |
|
| 56 | The benefit of using `seo` components over manual `meta` tag configuration is API simplicity, since `seo` automatically configures duplicate [Open Graph](https://ogp.me/)/social meta tags for you.
|
| 57 |
|
| 58 | If something here doesn't cover your use case, please feel free to [open an issue](https://github.com/natemoo-re/microsite/issues/new).
|
| 59 |
|
| 60 | ```tsx
|
| 61 | import { Head, seo } from "microsite/head";
|
| 62 |
|
| 63 | <Head>
|
| 64 | <seo.title>Easy SEO</seo.title>
|
| 65 | <seo.description>Hello world!</seo.description>
|
| 66 | <seo.image
|
| 67 | src="https://og-image.now.sh/**Hello**%20World.png?theme=light&md=1&fontSize=100px&images=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Ffront%2Fassets%2Fdesign%2Fvercel-triangle-black.svg"
|
| 68 | width={100}
|
| 69 | height={100}
|
| 70 | />
|
| 71 | <seo.twitter handle="@n_moore" />
|
| 72 | </Head>;
|
| 73 | ```
|
| 74 |
|
| 75 | #### seo.robots
|
| 76 |
|
| 77 | By default, `<Head>` now automatically adds the following tags.
|
| 78 |
|
| 79 | ```html
|
| 80 | <meta name="robots" content="index,follow" />
|
| 81 | <meta name="googlebot" content="index,follow" />
|
| 82 | ```
|
| 83 |
|
| 84 | This behavior can be controlled with the `<seo.robots>` helper, which accepts `noindex` and `nofollow` booleans.
|
| 85 |
|
| 86 | ```tsx
|
| 87 | <seo.robots noindex nofollow />
|
| 88 | ```
|
| 89 |
|
| 90 | #### seo.title
|
| 91 |
|
| 92 | `<seo.title>` has the same API as a regular `<title>` tag—it accepts a `string` child. `<seo.title>` sets the page `<title>` as well as `<meta property="og:title">`.
|
| 93 |
|
| 94 | #### seo.description
|
| 95 |
|
| 96 | `<seo.description>` accepts a `string` child. `<seo.description>` sets `<meta name="description">` as well as `<meta property="og:description">`.
|
| 97 |
|
| 98 | #### seo.canonical
|
| 99 |
|
| 100 | `<seo.canonical>` accepts a `string` child representing the canonical URL of the current page. It generates `<link rel="canonical">` and `<meta property="og:url">`.
|
| 101 |
|
| 102 | #### seo.image
|
| 103 |
|
| 104 | `<seo.image>` exposes an API similar to the native `<img>`, accepting `src`, `alt`, `width`, and `height` props. It generates all the meta tags necessary for valid Open Graph images.
|
| 105 |
|
| 106 | #### seo.video
|
| 107 |
|
| 108 | `<seo.video>` exposes an API similar to the native `<video>`, accepting `src`, `width`, and `height` props. It generates all the meta tags necessary for valid Open Graph videos.
|
| 109 |
|
| 110 | #### seo.audio
|
| 111 |
|
| 112 | `<seo.audio>` exposes an API similar to the native `<audio>`, accepting only a `src` prop. It generates all the meta tags necessary for valid Open Graph audio.
|
| 113 |
|
| 114 | #### seo.twitter
|
| 115 |
|
| 116 | `<seo.twitter>` controls [Twitter meta tags](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup). It accepts `card`, `handle` (maps to `twitter:creator`), and `site`.
|
| 117 |
|
| 118 | #### seo.facebook
|
| 119 |
|
| 120 | `<seo.facebook>` accepts an `appId` in order to set `<meta property="fb:app_id">`.
|
| 121 |
|
| 122 | #### seo.openGraph
|
| 123 |
|
| 124 | `<seo.openGraph>` provides low-level control over [Open Graph meta tags](https://ogp.me/). The accepted props vary based on `type`, so you might want to dig [into the code](https://github.com/natemoo-re/microsite/blob/8c0599f8c05da3214534b864c536a2614a89fb7f/src/head.tsx#L14) for this one.
|
| 125 |
|
| 126 | - 17e3130: Fix issue when building projects without optional global/hydrated files
|
| 127 | - da6e0f3: Improve build performance (parallelization)
|
| 128 | - eaec00b: Fixes issue with static path generation for the `/` route
|
| 129 |
|
| 130 | ## 0.5.0-alpha.0
|
| 131 |
|
| 132 | ### Minor Changes
|
| 133 |
|
| 134 | - 47eec22: **Build performance improvements**
|
| 135 |
|
| 136 | Rather than relying on [`@rollup/plugin-typescript`](https://github.com/rollup/plugins/tree/master/packages/typescript) (which uses `typescript` under the hood), we have switched to [`rollup-plugin-esbuild`](https://github.com/egoist/rollup-plugin-esbuild) to perform code transforms.
|
| 137 |
|
| 138 | [`esbuild`](https://github.com/evanw/esbuild) is very very fast. Now, so is Microsite.
|
| 139 |
|
| 140 | ### Patch Changes
|
| 141 |
|
| 142 | - 945685d: **SEO**
|
| 143 |
|
| 144 | Microsite aims to make SEO as simple as possible, so this featureset adds built-in SEO utility components to `microsite/head` under the `seo` namespace.
|
| 145 |
|
| 146 | The benefit of using `seo` components over manual `meta` tag configuration is API simplicity, since `seo` automatically configures duplicate [Open Graph](https://ogp.me/)/social meta tags for you.
|
| 147 |
|
| 148 | If something here doesn't cover your use case, please feel free to [open an issue](https://github.com/natemoo-re/microsite/issues/new).
|
| 149 |
|
| 150 | ```tsx
|
| 151 | import { Head, seo } from "microsite/head";
|
| 152 |
|
| 153 | <Head>
|
| 154 | <seo.title>Easy SEO</seo.title>
|
| 155 | <seo.description>Hello world!</seo.description>
|
| 156 | <seo.image
|
| 157 | src="https://og-image.now.sh/**Hello**%20World.png?theme=light&md=1&fontSize=100px&images=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Ffront%2Fassets%2Fdesign%2Fvercel-triangle-black.svg"
|
| 158 | width={100}
|
| 159 | height={100}
|
| 160 | />
|
| 161 | <seo.twitter handle="@n_moore" />
|
| 162 | </Head>;
|
| 163 | ```
|
| 164 |
|
| 165 | #### seo.robots
|
| 166 |
|
| 167 | By default, `<Head>` now automatically adds the following tags.
|
| 168 |
|
| 169 | ```html
|
| 170 | <meta name="robots" content="index,follow" />
|
| 171 | <meta name="googlebot" content="index,follow" />
|
| 172 | ```
|
| 173 |
|
| 174 | This behavior can be controlled with the `<seo.robots>` helper, which accepts `noindex` and `nofollow` booleans.
|
| 175 |
|
| 176 | ```tsx
|
| 177 | <seo.robots noindex nofollow />
|
| 178 | ```
|
| 179 |
|
| 180 | #### seo.title
|
| 181 |
|
| 182 | `<seo.title>` has the same API as a regular `<title>` tag—it accepts a `string` child. `<seo.title>` sets the page `<title>` as well as `<meta property="og:title">`.
|
| 183 |
|
| 184 | #### seo.description
|
| 185 |
|
| 186 | `<seo.description>` accepts a `string` child. `<seo.description>` sets `<meta name="description">` as well as `<meta property="og:description">`.
|
| 187 |
|
| 188 | #### seo.canonical
|
| 189 |
|
| 190 | `<seo.canonical>` accepts a `string` child representing the canonical URL of the current page. It generates `<link rel="canonical">` and `<meta property="og:url">`.
|
| 191 |
|
| 192 | #### seo.image
|
| 193 |
|
| 194 | `<seo.image>` exposes an API similar to the native `<img>`, accepting `src`, `alt`, `width`, and `height` props. It generates all the meta tags necessary for valid Open Graph images.
|
| 195 |
|
| 196 | #### seo.video
|
| 197 |
|
| 198 | `<seo.video>` exposes an API similar to the native `<video>`, accepting `src`, `width`, and `height` props. It generates all the meta tags necessary for valid Open Graph videos.
|
| 199 |
|
| 200 | #### seo.audio
|
| 201 |
|
| 202 | `<seo.audio>` exposes an API similar to the native `<audio>`, accepting only a `src` prop. It generates all the meta tags necessary for valid Open Graph audio.
|
| 203 |
|
| 204 | #### seo.twitter
|
| 205 |
|
| 206 | `<seo.twitter>` controls [Twitter meta tags](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup). It accepts `card`, `handle` (maps to `twitter:creator`), and `site`.
|
| 207 |
|
| 208 | #### seo.facebook
|
| 209 |
|
| 210 | `<seo.facebook>` accepts an `appId` in order to set `<meta property="fb:app_id">`.
|
| 211 |
|
| 212 | #### seo.openGraph
|
| 213 |
|
| 214 | `<seo.openGraph>` provides low-level control over [Open Graph meta tags](https://ogp.me/). The accepted props vary based on `type`, so you might want to dig [into the code](https://github.com/natemoo-re/microsite/blob/8c0599f8c05da3214534b864c536a2614a89fb7f/src/head.tsx#L14) for this one.
|
| 215 | |
| \ | No newline at end of file |