| 1 | # microsite
|
| 2 |
|
| 3 | ## 0.6.6
|
| 4 |
|
| 5 | ### Patch Changes
|
| 6 |
|
| 7 | - 7e955a0: Ensure children is not required for Head component
|
| 8 |
|
| 9 | ## 0.6.5
|
| 10 |
|
| 11 | ### Patch Changes
|
| 12 |
|
| 13 | - f65c7f4: Improve types by adding global `h` and `Fragment`, and ambient `*.modules.css` declarations
|
| 14 |
|
| 15 | ## 0.6.4
|
| 16 |
|
| 17 | ### Patch Changes
|
| 18 |
|
| 19 | - e53864f: Update default `tsconfig` to be named `base`.
|
| 20 |
|
| 21 | Update `tsconfig.baseUrl` to resolve from inside `node_modules`
|
| 22 |
|
| 23 | ## 0.6.3
|
| 24 |
|
| 25 | ### Patch Changes
|
| 26 |
|
| 27 | - a760228: Automatically inject h and Fragment
|
| 28 | - 580bb4f: expose default tsconfig.json for end-users
|
| 29 |
|
| 30 | ## 0.6.2
|
| 31 |
|
| 32 | ### Patch Changes
|
| 33 |
|
| 34 | - 60de6a2: Fix esbuild jsxFactory
|
| 35 |
|
| 36 | ## 0.6.1
|
| 37 |
|
| 38 | ### Patch Changes
|
| 39 |
|
| 40 | - a3a5131: Fix external warning
|
| 41 | - 5c79ec3: update README
|
| 42 |
|
| 43 | ## 0.6.0
|
| 44 |
|
| 45 | ### Breaking Changes
|
| 46 |
|
| 47 | - 9d0e9cc: Drop `@types/react` and switch to `preact`. See issue [#5](https://github.com/natemoo-re/microsite/issues/5) for more background.
|
| 48 |
|
| 49 | ## 0.0.0-canary-2020101419274
|
| 50 |
|
| 51 | ### Breaking Changes
|
| 52 |
|
| 53 | - 7fd4679: Drop `@types/react` and switch to `preact`. See issue [#5](https://github.com/natemoo-re/microsite/issues/5) for more background.
|
| 54 |
|
| 55 | ## 0.5.1
|
| 56 |
|
| 57 | ### Patch Changes
|
| 58 |
|
| 59 | - 3d99331: Fix handling of node builtins for intermediate builds
|
| 60 | - 3d99331: Remove .microsite/cache dir for now
|
| 61 |
|
| 62 | ## 0.5.1-next.0
|
| 63 |
|
| 64 | ### Patch Changes
|
| 65 |
|
| 66 | - a29b71e: Fix handling of node builtins for intermediate builds
|
| 67 | - 078b910: Remove .microsite/cache dir for now
|
| 68 |
|
| 69 | ## 0.5.0
|
| 70 |
|
| 71 | ### Minor Changes
|
| 72 |
|
| 73 | - 47eec22: **Build performance improvements**
|
| 74 |
|
| 75 | 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.
|
| 76 |
|
| 77 | [`esbuild`](https://github.com/evanw/esbuild) is very very fast. Now, so is Microsite.
|
| 78 |
|
| 79 | ### Patch Changes
|
| 80 |
|
| 81 | - 275f297: Gracefully handle Component/export name mismatch
|
| 82 |
|
| 83 | Automatically handle `tsconfig.paths` aliases
|
| 84 |
|
| 85 | - 945685d: **SEO**
|
| 86 |
|
| 87 | 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.
|
| 88 |
|
| 89 | 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.
|
| 90 |
|
| 91 | If something here doesn't cover your use case, please feel free to [open an issue](https://github.com/natemoo-re/microsite/issues/new).
|
| 92 |
|
| 93 | ```tsx
|
| 94 | import { Head, seo } from "microsite/head";
|
| 95 |
|
| 96 | <Head>
|
| 97 | <seo.title>Easy SEO</seo.title>
|
| 98 | <seo.description>Hello world!</seo.description>
|
| 99 | <seo.image
|
| 100 | 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"
|
| 101 | width={100}
|
| 102 | height={100}
|
| 103 | />
|
| 104 | <seo.twitter handle="@n_moore" />
|
| 105 | </Head>;
|
| 106 | ```
|
| 107 |
|
| 108 | #### seo.robots
|
| 109 |
|
| 110 | By default, `<Head>` now automatically adds the following tags.
|
| 111 |
|
| 112 | ```html
|
| 113 | <meta name="robots" content="index,follow" />
|
| 114 | <meta name="googlebot" content="index,follow" />
|
| 115 | ```
|
| 116 |
|
| 117 | This behavior can be controlled with the `<seo.robots>` helper, which accepts `noindex` and `nofollow` booleans.
|
| 118 |
|
| 119 | ```tsx
|
| 120 | <seo.robots noindex nofollow />
|
| 121 | ```
|
| 122 |
|
| 123 | #### seo.title
|
| 124 |
|
| 125 | `<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">`.
|
| 126 |
|
| 127 | #### seo.description
|
| 128 |
|
| 129 | `<seo.description>` accepts a `string` child. `<seo.description>` sets `<meta name="description">` as well as `<meta property="og:description">`.
|
| 130 |
|
| 131 | #### seo.canonical
|
| 132 |
|
| 133 | `<seo.canonical>` accepts a `string` child representing the canonical URL of the current page. It generates `<link rel="canonical">` and `<meta property="og:url">`.
|
| 134 |
|
| 135 | #### seo.image
|
| 136 |
|
| 137 | `<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.
|
| 138 |
|
| 139 | #### seo.video
|
| 140 |
|
| 141 | `<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.
|
| 142 |
|
| 143 | #### seo.audio
|
| 144 |
|
| 145 | `<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.
|
| 146 |
|
| 147 | #### seo.twitter
|
| 148 |
|
| 149 | `<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`.
|
| 150 |
|
| 151 | #### seo.facebook
|
| 152 |
|
| 153 | `<seo.facebook>` accepts an `appId` in order to set `<meta property="fb:app_id">`.
|
| 154 |
|
| 155 | #### seo.openGraph
|
| 156 |
|
| 157 | `<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.
|
| 158 |
|
| 159 | - 17e3130: Fix issue when building projects without optional global/hydrated files
|
| 160 | - da6e0f3: Improve build performance (parallelization)
|
| 161 | - eaec00b: Fixes issue with static path generation for the `/` route
|
| 162 |
|
| 163 | ## 0.5.0-alpha.0
|
| 164 |
|
| 165 | ### Minor Changes
|
| 166 |
|
| 167 | - 47eec22: **Build performance improvements**
|
| 168 |
|
| 169 | 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.
|
| 170 |
|
| 171 | [`esbuild`](https://github.com/evanw/esbuild) is very very fast. Now, so is Microsite.
|
| 172 |
|
| 173 | ### Patch Changes
|
| 174 |
|
| 175 | - 945685d: **SEO**
|
| 176 |
|
| 177 | 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.
|
| 178 |
|
| 179 | 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.
|
| 180 |
|
| 181 | If something here doesn't cover your use case, please feel free to [open an issue](https://github.com/natemoo-re/microsite/issues/new).
|
| 182 |
|
| 183 | ```tsx
|
| 184 | import { Head, seo } from "microsite/head";
|
| 185 |
|
| 186 | <Head>
|
| 187 | <seo.title>Easy SEO</seo.title>
|
| 188 | <seo.description>Hello world!</seo.description>
|
| 189 | <seo.image
|
| 190 | 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"
|
| 191 | width={100}
|
| 192 | height={100}
|
| 193 | />
|
| 194 | <seo.twitter handle="@n_moore" />
|
| 195 | </Head>;
|
| 196 | ```
|
| 197 |
|
| 198 | #### seo.robots
|
| 199 |
|
| 200 | By default, `<Head>` now automatically adds the following tags.
|
| 201 |
|
| 202 | ```html
|
| 203 | <meta name="robots" content="index,follow" />
|
| 204 | <meta name="googlebot" content="index,follow" />
|
| 205 | ```
|
| 206 |
|
| 207 | This behavior can be controlled with the `<seo.robots>` helper, which accepts `noindex` and `nofollow` booleans.
|
| 208 |
|
| 209 | ```tsx
|
| 210 | <seo.robots noindex nofollow />
|
| 211 | ```
|
| 212 |
|
| 213 | #### seo.title
|
| 214 |
|
| 215 | `<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">`.
|
| 216 |
|
| 217 | #### seo.description
|
| 218 |
|
| 219 | `<seo.description>` accepts a `string` child. `<seo.description>` sets `<meta name="description">` as well as `<meta property="og:description">`.
|
| 220 |
|
| 221 | #### seo.canonical
|
| 222 |
|
| 223 | `<seo.canonical>` accepts a `string` child representing the canonical URL of the current page. It generates `<link rel="canonical">` and `<meta property="og:url">`.
|
| 224 |
|
| 225 | #### seo.image
|
| 226 |
|
| 227 | `<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.
|
| 228 |
|
| 229 | #### seo.video
|
| 230 |
|
| 231 | `<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.
|
| 232 |
|
| 233 | #### seo.audio
|
| 234 |
|
| 235 | `<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.
|
| 236 |
|
| 237 | #### seo.twitter
|
| 238 |
|
| 239 | `<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`.
|
| 240 |
|
| 241 | #### seo.facebook
|
| 242 |
|
| 243 | `<seo.facebook>` accepts an `appId` in order to set `<meta property="fb:app_id">`.
|
| 244 |
|
| 245 | #### seo.openGraph
|
| 246 |
|
| 247 | `<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.
|
| 248 | |
| \ | No newline at end of file |