microsite

# microsite ## 1.2.1 ### Patch Changes - 7e7f215: Fix issue with dynamic routes in dev mode (#144) - faed63e: Fix #137 by not hardcoding Preact CDN sources ## 1.2.0 ### Minor Changes - 3683b12: Enabled the use of `snowpack.config.js` in ESM format to mirror Snowpack's new support. Cleaned up some unused internal files and removed their dependencies. Removed automatic PostCSS handling. If you have a PostCSS config file, it is your responsibility to create a `snowpack.config.js` file and install and configure `@snowpack/plugin-postcss`. ## 1.1.0 ### Minor Changes - 889da9a: Implements fragment-based hydration. This is a **breaking change**—the previous behavior was to wrap any hydrated components in a `div` with `display: contents` but this new behavior has the benefit of not modifying the document flow at all. **Breaking change**: The `interaction` hydration strategy has been removed. In practice it tended to actually _cause_ interaction delays because hydration work would occur in an input-blocking fashion. Use `idle` or `visible`. ### Patch Changes - 53ea544: Fixed a bug when using any --flag with "microsite" CLI - 889da9a: Add support for deployment to a relative subdirectory. To enable this behavior, either set `"homepage": "/subdir"` in `package.json` or pass `--base-path=/subdir` to `microsite build`. - c3e1ec5: Always output hashed files with an 8 character hash - 0c9d426: Include shim for `requestIdleCallback` for Safari - 0c9d426: Fix error with previous shared CSS module logic, adds \_static output directory - 0c9d426: Fix <Head> component bug - 0c9d426: Update hydration method to be compatible with `preact@10.5.11+`. Allows `preact@^10.5.12`. - 0c9d426: Remove prettier from core dependencies - 2468a3a: Dev server now uses `etag` for caching and chunk behavior for `global/index.ts` files has been fixed - 06f439b: Add `--no-open` flag to `microsite dev` and `microsite build --serve`. This flag allows you to skip the default behavior of automatically opening your browser. - 0c9d426: Prefer pinned Skypack URLs to lookup URLs. Improves load waterfall significantly. Fixes #106. - 0c9d426: Adds a `fallback` option to `withHydrate` to allow customization of server-side rendering behavior. - 0c9d426: Pin `preact@10.5.10` and `snowpack@~3.0.11` - 0c9d426: Remove PostCSS logic from core dependencies. Microsite will prompt users to install PostCSS locally if detected. - efdc433: Add support for custom "pages/\_document.tsx" file - 355eb2b: Fixed a bug with custom document rendering - 0c9d426: Fix missed edge case with CSS module assets shared between pages (#126) - 0c9d426: Update snowpack to snowpack@3.0.13 - 0c9d426: fix(#119): remove `defer` from inline script` fix(#115): do not include vendor chunk in hydrateBindings - db45d3b: Add support for custom "snowpack.config.cjs" files ## 1.1.0-next.11 ### Patch Changes - 6723b24: Adds a `fallback` option to `withHydrate` to allow customization of server-side rendering behavior. ## 1.1.0-next.10 ### Patch Changes - 7fcba84: Fix error with previous shared CSS module logic, adds \_static output directory ## 1.1.0-next.9 ### Patch Changes - 64ca86e: Fix missed edge case with CSS module assets shared between pages (#126) ## 1.1.0-next.8 ### Patch Changes - 3d8b6e0: Prefer pinned Skypack URLs to lookup URLs. Improves load waterfall significantly. Fixes #106. - 81b1f9a: Update snowpack to snowpack@3.0.13 ## 1.1.0-next.7 ### Patch Changes - fix(#119): remove `defer` from inline script` - fix(#115): do not include vendor chunk in hydrateBindings ## 1.1.0-next.6 ### Patch Changes - ddd48ea: Include shim for `requestIdleCallback` for Safari - d486147: Update hydration method to be compatible with `preact@10.5.11+`. Allows `preact@^10.5.12`. ## 1.1.0-next.5 ### Patch Changes - Pin `preact@10.5.10` and `snowpack@~3.0.11` ## 1.1.0-next.4 ### Patch Changes - 4c63780: Fix <Head> component bug - 669eab2: Remove prettier from core dependencies - 1eb8733: Remove PostCSS logic from core dependencies. Microsite will prompt users to install PostCSS locally if detected. ## 1.1.0-next.3 ### Patch Changes - 2468a3a: Dev server now uses `etag` for caching and chunk behavior for `global/index.ts` files has been fixed ## 1.1.0-next.2 ### Patch Changes - Fixed a bug with custom document rendering ## 1.1.0-next.1 ### Patch Changes - 53ea544: Fixed a bug when using any --flag with "microsite" CLI - c3e1ec5: Always output hashed files with an 8 character hash - 06f439b: Add `--no-open` flag to `microsite dev` and `microsite build --serve`. This flag allows you to skip the default behavior of automatically opening your browser. - efdc433: Add support for custom "pages/\_document.tsx" file - db45d3b: Add support for custom "snowpack.config.cjs" files ## 1.1.0-next.0 ### Minor Changes - 889da9a: Implements fragment-based hydration. This is a **breaking change**—the previous behavior was to wrap any hydrated components in a `div` with `display: contents` but this new behavior has the benefit of not modifying the document flow at all. **Breaking change**: The `interaction` hydration strategy has been removed. In practice it tended to actually _cause_ interaction delays because hydration work would occur in an input-blocking fashion. Use `idle` or `visible`. ### Patch Changes - 889da9a: Add support for deployment to a relative subdirectory. To enable this behavior, either set `"homepage": "/subdir"` in `package.json` or pass `--base-path=/subdir` to `microsite build`. ## 1.0.3 ### Patch Changes - b94b6a9: Fix handling of js/tsconfig.json without a "paths" option ## 1.0.2 ### Patch Changes - 1559789: Fix bug with Snowpack's esinstall and Microsite's global state utility - 9241da7: - Update @prefresh/snowpack to effectively update effects and memoization ## 1.0.1 ### Patch Changes - 41f0201: Remove init script if no hydrated components exist - fe2d1d7: Resolve exact version of Preact used in project - 712dc53: Fixes build issue where no esm dependencies would be found ## 1.0.0 ### Major Changes - 2ae753d: Microsite has been completely rewritten to focus on what it does best—optimize your static site for partial hydration. Rather than implementing a highly-opinionated, custom build pipeline, Microsite@1.0.0 leverages the power of [Snowpack](https://www.snowpack.dev/)'s upcoming 3.0.0 release. This means that there are a number of new features, notably: - Pages can now be written in your preferred file format—TypeScript or plain old JavaScript. - If your file/asset types are [supported in Snowpack](https://www.snowpack.dev/reference/supported-files), they are supported by Microsite. This is because Microsite has delegated the initial compilation of your site completely to Snowpack! - `microsite dev` spins up a Snowpack development server with best-in-class DX, including built-in HMR with [Prefresh](https://github.com/JoviDeCroock/prefresh/tree/main). - `microsite build --serve` performs a build and serves the result on a local server, for testing production builds. There are a small number of breaking changes in the release: - Microsite now relies on explicit [subpath exports](https://nodejs.org/api/packages.html#packages_subpath_exports), meaning only public files can be accessed from Node. - Global asset entry points have been moved from `src/global.ts` and `src/global.css` to `src/global/index.ts` and `src/global/index.css`. - Global scripts are no longer executed as a side-effect. Global scripts must contain a single `export default async () => {}`, which is executed on page load. ### Patch Changes - 914bf18: Fix cosmicconfig CJS interop issue - 727fc04: Remove cache dir for now - 7681446: Fixed a bug where automatic JSX inject would not always be triggered - d5993d7: Automatically use PostCSS if a postcss.config.cjs file is found - a3b38a8: Automatic JSX injection is fixed (I really mean it this time.) Added automatic aliasing for `tsconfig` `paths`. Fixed a bug where `microsite/global` was not included in the vendor bundle. Fixed a bug where `shared` components would not be concatenated into a single chunk. Added minification for the `init` hydration script. - c17d109: Fix bug with JSX Pragma injection - 1dff58f: Fixed issue with automatic environment typings. Fixed issue where JSX pragma (`h`, `Fragment`) was not being automatically injected. Enabled Snowpack to pick up on `tsconfig.json` or `jsconfig.json` `paths` aliases automatically. ## 1.0.0-next.7 ### Patch Changes - 727fc04: Remove cache dir for now ## 1.0.0-next.6 ### Patch Changes - 914bf18: Fix cosmicconfig CJS interop issue ## 1.0.0-next.5 ### Patch Changes - Automatically use PostCSS if a postcss.config.cjs file is found ## 1.0.0-next.4 ### Patch Changes - a3b38a8: Automatic JSX injection is fixed (I really mean it this time.) Added automatic aliasing for `tsconfig` `paths`. Fixed a bug where `microsite/global` was not included in the vendor bundle. Fixed a bug where `shared` components would not be concatenated into a single chunk. Added minification for the `init` hydration script. ## 1.0.0-next.3 ### Patch Changes - 7681446: Fixed a bug where automatic JSX inject would not always be triggered ## 1.0.0-next.2 ### Patch Changes - Fix bug with JSX Pragma injection ## 1.0.0-next.1 ### Patch Changes - Fixed issue with automatic environment typings. Fixed issue where JSX pragma (`h`, `Fragment`) was not being automatically injected. Enabled Snowpack to pick up on `tsconfig.json` or `jsconfig.json` `paths` aliases automatically. ## 1.0.0-next.0 ### Major Changes - 2ae753d: Microsite has been completely rewritten to focus on what it does best—optimize your static site for partial hydration. Rather than implementing a highly-opinionated, custom build pipeline, Microsite@1.0.0 leverages the power of [Snowpack](https://www.snowpack.dev/)'s upcoming 3.0.0 release. This means that there are a number of new features, notably: - Pages can now be written in your preferred file format—TypeScript or plain old JavaScript. - If your file/asset types are [supported in Snowpack](https://www.snowpack.dev/reference/supported-files), they are supported by Microsite. This is because Microsite has delegated the initial compilation of your site completely to Snowpack! - `microsite dev` spins up a Snowpack development server with best-in-class DX, including built-in HMR with [Prefresh](https://github.com/JoviDeCroock/prefresh/tree/main). - `microsite build --serve` performs a build and serves the result on a local server, for testing production builds. There are a small number of breaking changes in the release: - Microsite now relies on explicit [subpath exports](https://nodejs.org/api/packages.html#packages_subpath_exports), meaning only public files can be accessed from Node. - Global asset entry points have been moved from `src/global.ts` and `src/global.css` to `src/global/index.ts` and `src/global/index.css`. - Global scripts are no longer executed as a side-effect. Global scripts must contain a single `export default async () => {}`, which is executed on page load. ## 0.7.6 ### Patch Changes - 837da9c: Fix issue with `<pre> <code>` dedent ## 0.7.5 ### Patch Changes - cb4da30: Fix dedent within <pre> tags ## 0.7.4 ### Patch Changes - 5eb1b20: Fix issue where shared styles of non-hydrated components would not be included in the output ## 0.7.3 ### Patch Changes - 2535fe9: Fix bug where global script would have extra code injected ## 0.7.2 ### Patch Changes - c71d8da: Whoops, actually fix that bundling bug ## 0.7.1 ### Patch Changes - bf8cfa0: Fix bundling bug ## 0.7.0 ### Minor Changes - 65bf0bd: Implements a caching strategy for `getStaticProps` and `getStaticPaths`, which can often become a build bottleneck due to network or filesystem reads. This change introduces a new `prefetch` method for both of these functions. [Read the docs](/docs/data-fetching) for more details. ### Patch Changes - 4475a3c: Update prefetch logic to accomodate changing headers - f3b313b: Update to esbuild@0.8.x ## 0.7.0-next.2 ### Patch Changes - 4475a3c: Update prefetch logic to accomodate changing headers ## 0.7.0-next.1 ### Patch Changes - f3b313b: Update to esbuild@0.8.x ## 0.7.0-next.0 ### Minor Changes - 65bf0bd: Implements a caching strategy for `getStaticProps` and `getStaticPaths`, which can often become a build bottleneck due to network or filesystem reads. This change introduces a new `prefetch` method for both of these functions. [Read the docs](/docs/data-fetching) for more details. ## 0.6.14 ### Patch Changes - e18c71c: Fix Linux shebang issue (#40) by removing need for --experimental-module-resolution=node. Uses .js import specifiers everywhere ## 0.6.13 ### Patch Changes - 86bdb17: Fix bug where <pre> code was improperly indented ## 0.6.12 ### Patch Changes - 9d22932: Update to typescript@4.1.2 - 217299b: Update Document viewport meta tag, html lang and dir ## 0.6.12-next.0 ### Patch Changes - 9d22932: Update to typescript@4.1.2 - 217299b: Update Document viewport meta tag, html lang and dir ## 0.6.11 ### Minor Changes - fd4c454: Add [HTTP Caching](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching) to `fetch` via [`make-fetch-happen`](https://github.com/zkat/make-fetch-happen/). Thanks [@zkat](https://github.com/zkat)! ## 0.6.10 ### Patch Changes - 8a7374f: Add preload hints for hydrated pages - 6d0f3a3: Microsite's partial hydration method manages each component as a seperate Preact tree, meaning standard `Context` won't work across components. This update adds a `microsite/global` entry point which exposes two utilities for sharing state across component trees. **`createGlobalState`** creates a [`Proxy`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) which acts as a mutable data source. Mutating this object notifies any consuming components that they should rerender. > If you're a fan of Vue, this is very similar to `reactive` from the Composition API. Components can consume this global state object via **`useGlobalState(state)`**. ```tsx // utils/state.tsx import { createGlobalState } from "microsite/global"; export const state = createGlobalState({ count: 0 }); // components/Counter.tsx import { withHydrate } from "microsite/hydrate"; import { useGlobalState } from "microsite/global"; import { state } from "@/utils/state"; const Counter = () => { const localState = useGlobalState(state); // `localState` is a readonly snapshot of global `state` // Updates can be written to global `state` by direct mutation return ( <> <button onClick={() => state.count--}>-</button> <span>{localState.count}</span> <button onClick={() => state.count++}>+</button> </> ); }; export default withHydrate(Counter); ``` - 6d0f3a3: Fix issue with CSS scoped name generation ## 0.6.9 ### Patch Changes - 788860d: Add --no-clean flag to persist intermediate build (useful for debugging) - 64add28: Fixes issue with named hydration chunks - 10f9fd5: Improve caching by using external styles rather than inlined styles - 0641e72: Update microsite bin to use correct arguments ## 0.6.9-next.0 ### Patch Changes - Add --no-clean flag to persist intermediate build (useful for debugging) ## 0.6.6 ### Patch Changes - 7e955a0: Ensure children is not required for Head component ## 0.6.5 ### Patch Changes - f65c7f4: Improve types by adding global `h` and `Fragment`, and ambient `*.modules.css` declarations ## 0.6.4 ### Patch Changes - e53864f: Update default `tsconfig` to be named `base`. Update `tsconfig.baseUrl` to resolve from inside `node_modules` ## 0.6.3 ### Patch Changes - a760228: Automatically inject h and Fragment - 580bb4f: expose default tsconfig.json for end-users ## 0.6.2 ### Patch Changes - 60de6a2: Fix esbuild jsxFactory ## 0.6.1 ### Patch Changes - a3a5131: Fix external warning - 5c79ec3: update README ## 0.6.0 ### Breaking Changes - 9d0e9cc: Drop `@types/react` and switch to `preact`. See issue [#5](https://github.com/natemoo-re/microsite/issues/5) for more background. ## 0.0.0-canary-2020101419274 ### Breaking Changes - 7fd4679: Drop `@types/react` and switch to `preact`. See issue [#5](https://github.com/natemoo-re/microsite/issues/5) for more background. ## 0.5.1 ### Patch Changes - 3d99331: Fix handling of node builtins for intermediate builds - 3d99331: Remove .microsite/cache dir for now ## 0.5.1-next.0 ### Patch Changes - a29b71e: Fix handling of node builtins for intermediate builds - 078b910: Remove .microsite/cache dir for now ## 0.5.0 ### Minor Changes - 47eec22: **Build performance improvements** 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. [`esbuild`](https://github.com/evanw/esbuild) is very very fast. Now, so is Microsite. ### Patch Changes - 275f297: Gracefully handle Component/export name mismatch Automatically handle `tsconfig.paths` aliases - 945685d: **SEO** 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. 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. If something here doesn't cover your use case, please feel free to [open an issue](https://github.com/natemoo-re/microsite/issues/new). ```tsx import { Head, seo } from "microsite/head"; <Head> <seo.title>Easy SEO</seo.title> <seo.description>Hello world!</seo.description> <seo.image 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" width={100} height={100} /> <seo.twitter handle="@n_moore" /> </Head>; ``` #### seo.robots By default, `<Head>` now automatically adds the following tags. ```html <meta name="robots" content="index,follow" /> <meta name="googlebot" content="index,follow" /> ``` This behavior can be controlled with the `<seo.robots>` helper, which accepts `noindex` and `nofollow` booleans. ```tsx <seo.robots noindex nofollow /> ``` #### seo.title `<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">`. #### seo.description `<seo.description>` accepts a `string` child. `<seo.description>` sets `<meta name="description">` as well as `<meta property="og:description">`. #### seo.canonical `<seo.canonical>` accepts a `string` child representing the canonical URL of the current page. It generates `<link rel="canonical">` and `<meta property="og:url">`. #### seo.image `<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. #### seo.video `<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. #### seo.audio `<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. #### seo.twitter `<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`. #### seo.facebook `<seo.facebook>` accepts an `appId` in order to set `<meta property="fb:app_id">`. #### seo.openGraph `<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. - 17e3130: Fix issue when building projects without optional global/hydrated files - da6e0f3: Improve build performance (parallelization) - eaec00b: Fixes issue with static path generation for the `/` route ## 0.5.0-alpha.0 ### Minor Changes - 47eec22: **Build performance improvements** 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. [`esbuild`](https://github.com/evanw/esbuild) is very very fast. Now, so is Microsite. ### Patch Changes - 945685d: **SEO** 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. 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. If something here doesn't cover your use case, please feel free to [open an issue](https://github.com/natemoo-re/microsite/issues/new). ```tsx import { Head, seo } from "microsite/head"; <Head> <seo.title>Easy SEO</seo.title> <seo.description>Hello world!</seo.description> <seo.image 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" width={100} height={100} /> <seo.twitter handle="@n_moore" /> </Head>; ``` #### seo.robots By default, `<Head>` now automatically adds the following tags. ```html <meta name="robots" content="index,follow" /> <meta name="googlebot" content="index,follow" /> ``` This behavior can be controlled with the `<seo.robots>` helper, which accepts `noindex` and `nofollow` booleans. ```tsx <seo.robots noindex nofollow /> ``` #### seo.title `<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">`. #### seo.description `<seo.description>` accepts a `string` child. `<seo.description>` sets `<meta name="description">` as well as `<meta property="og:description">`. #### seo.canonical `<seo.canonical>` accepts a `string` child representing the canonical URL of the current page. It generates `<link rel="canonical">` and `<meta property="og:url">`. #### seo.image `<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. #### seo.video `<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. #### seo.audio `<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. #### seo.twitter `<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`. #### seo.facebook `<seo.facebook>` accepts an `appId` in order to set `<meta property="fb:app_id">`. #### seo.openGraph `<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.