Package aliases
Now that you have published a shared dependency to Eik and seen how to update it, it's time to set up an alias.
+Package aliases
Now that you have published a shared dependency to Eik and seen how to update it, it's time to set up an alias.
A refresher from the introduction:
Instead of importing specific versions, Eik encourages the use of aliases to share the same major semantic version between applications.
diff --git a/docs/dependencies/images/index.html b/docs/dependencies/images/index.html index 8be6dc4..c6a482d 100644 --- a/docs/dependencies/images/index.html +++ b/docs/dependencies/images/index.html @@ -2,13 +2,13 @@ - -Publishing to the image namespace | Eik - - + +Publishing to the image namespace | Eik + + -Publishing to the image namespace
The purpose of the image namespace is three-fold:
+Publishing to the image namespace
The purpose of the image namespace is three-fold:
- Files that change infrequently (images and other media) can be uploaded and versioned separately from files that change often (JavaScript and CSS).
- A service such as Fastly's image optimization can be placed in front of this namespace.
diff --git a/docs/dependencies/import-maps/index.html b/docs/dependencies/import-maps/index.html index 95b22d3..71374ae 100644 --- a/docs/dependencies/import-maps/index.html +++ b/docs/dependencies/import-maps/index.html @@ -2,13 +2,13 @@ - -Import maps | Eik - - + +Import maps | Eik + + -Import maps
Publishing shared dependencies and aliasing them helps nothing if application code doesn't use them. Import maps make it easier for developers to discover and use dependencies you publish to your Eik server.
+Import maps
Publishing shared dependencies and aliasing them helps nothing if application code doesn't use them. Import maps make it easier for developers to discover and use dependencies you publish to your Eik server.
A refresher from the introduction:
You can publish import maps to Eik in a similar way to dependencies and application code. Maps are versioned and immutable, and can be aliased in the same way other assets can.
diff --git a/docs/dependencies/introduction/index.html b/docs/dependencies/introduction/index.html index 9b8c3b8..75bc560 100644 --- a/docs/dependencies/introduction/index.html +++ b/docs/dependencies/introduction/index.html @@ -2,13 +2,13 @@ - -Package types | Eik - - + +Package types | Eik + + -Package types
Previously you learned how to start using Eik in an application, including how to do import mapping so shared dependencies only get downloaded, parsed and run once. For this to work, though, there must be shared dependencies available on the Eik server.
+Package types
Previously you learned how to start using Eik in an application, including how to do import mapping so shared dependencies only get downloaded, parsed and run once. For this to work, though, there must be shared dependencies available on the Eik server.
In the Managing dependencies section you'll learn how to:
- publish shared dependencies to the
diff --git a/docs/dependencies/npm/index.html b/docs/dependencies/npm/index.html index 26ffed5..2cb7662 100644 --- a/docs/dependencies/npm/index.html +++ b/docs/dependencies/npm/index.html @@ -2,13 +2,13 @@ - -npm
namespace on your Eik serverPublishing to the npm namespace | Eik - - + +Publishing to the npm namespace | Eik + + -Publishing to the npm namespace
Eik's main purpose is hosting shared ES modules. In this document you'll learn how to:
+Publishing to the npm namespace
Eik's main purpose is hosting shared ES modules. In this document you'll learn how to:
- publish a module from the npm registry to your Eik server
- how to update an existing module
diff --git a/docs/guides/browser-importmap/index.html b/docs/guides/browser-importmap/index.html index c5ce911..b6cbd61 100644 --- a/docs/guides/browser-importmap/index.html +++ b/docs/guides/browser-importmap/index.html @@ -2,13 +2,13 @@ - -Browser import mapping | Eik - - + +Browser import mapping | Eik + + -Browser import mapping
This document describes how to do import mapping in the browser and still use import maps hosted on Eik. That way a map can be updated on Eik and rolled out to applications without code changes or redeploys.
+Browser import mapping
This document describes how to do import mapping in the browser and still use import maps hosted on Eik. That way a map can be updated on Eik and rolled out to applications without code changes or redeploys.
tipCheck browser support for import maps (or use a polyfill) before you decide to use this approach. Eik has several plugins to do import mapping at build-time in order to support browsers that don't natively support import maps.
Differences from build-time mapping
diff --git a/docs/guides/esbuild/index.html b/docs/guides/esbuild/index.html index 95000ff..248fbdf 100644 --- a/docs/guides/esbuild/index.html +++ b/docs/guides/esbuild/index.html @@ -2,13 +2,13 @@ - -Using Eik with esbuild | Eik - - + +Using Eik with esbuild | Eik + + -Using Eik with esbuild
This guide describes how to configure esbuild to use build-time import mapping. The guide assumes you have an
+eik.json
containing at least one"import-map"
.Using Eik with esbuild
This guide describes how to configure esbuild to use build-time import mapping. The guide assumes you have an
eik.json
containing at least one"import-map"
.Getting started
Install
@eik/esbuild-plugin
, andesbuild
if you haven't already.diff --git a/docs/guides/github-actions-images/index.html b/docs/guides/github-actions-images/index.html index c90d56f..e2f64dc 100644 --- a/docs/guides/github-actions-images/index.html +++ b/docs/guides/github-actions-images/index.html @@ -2,13 +2,13 @@ - -npm install --save-dev esbuild @eik/esbuild-plugin
Publish images to Eik on GitHub Actions | Eik - - + +Publish images to Eik on GitHub Actions | Eik + + -Publish images to Eik on GitHub Actions
This guide describes how to use GitHub Actions to publish an image package to an Eik server.
+Publish images to Eik on GitHub Actions
This guide describes how to use GitHub Actions to publish an image package to an Eik server.
Prerequisites
Your repo needs to have access to an Eik login key. Store this as a Secret you can use in GitHub Actions.
In this guide we'll be using
diff --git a/docs/guides/github-actions/index.html b/docs/guides/github-actions/index.html index b7f5602..8906858 100644 --- a/docs/guides/github-actions/index.html +++ b/docs/guides/github-actions/index.html @@ -2,13 +2,13 @@ - -EIK_TOKEN
as the secret name.Publish to Eik on GitHub Actions | Eik - - + +Publish to Eik on GitHub Actions | Eik + + -Publish to Eik on GitHub Actions
This guide describes how to use GitHub Actions to publish to an Eik server. It describes two different approaches:
+Publish to Eik on GitHub Actions
This guide describes how to use GitHub Actions to publish to an Eik server. It describes two different approaches:
- Using Semantic Release
- Using the Eik CLI
diff --git a/docs/guides/postcss/index.html b/docs/guides/postcss/index.html index e404659..eb0fa5a 100644 --- a/docs/guides/postcss/index.html +++ b/docs/guides/postcss/index.html @@ -2,13 +2,13 @@ - -Using Eik with PostCSS | Eik - - + +Using Eik with PostCSS | Eik + + -Using Eik with PostCSS
This guide describes how to configure postcss to use build-time import mapping for your CSS. The guide assumes you have an
+eik.json
containing at least one"import-map"
.Using Eik with PostCSS
This guide describes how to configure postcss to use build-time import mapping for your CSS. The guide assumes you have an
eik.json
containing at least one"import-map"
.Getting started
Install
@eik/postcss-plugin
, andpostcss
if you haven't already.diff --git a/docs/guides/rollup/index.html b/docs/guides/rollup/index.html index 0d355be..03e5438 100644 --- a/docs/guides/rollup/index.html +++ b/docs/guides/rollup/index.html @@ -2,13 +2,13 @@ - -npm install --save-dev postcss postcss-cli @eik/postcss-plugin
Using Eik with Rollup | Eik - - + +Using Eik with Rollup | Eik + + -Using Eik with Rollup
This guide describes how to configure Rollup to use build-time import mapping. The guide assumes you have an
+eik.json
containing at least one"import-map"
.Using Eik with Rollup
This guide describes how to configure Rollup to use build-time import mapping. The guide assumes you have an
eik.json
containing at least one"import-map"
.Getting started
Install
@eik/rollup-plugin
, androllup
if you haven't already.diff --git a/docs/guides/travis/index.html b/docs/guides/travis/index.html index f3713a8..ab8b380 100644 --- a/docs/guides/travis/index.html +++ b/docs/guides/travis/index.html @@ -2,13 +2,13 @@ - -npm install --save-dev rollup @eik/rollup-plugin
Publish to Eik on Travis | Eik - - + +Publish to Eik on Travis | Eik + + -