🔌 Modules: ESM imports and configResolved 🔌

ElMassimo commented 2 years ago

Description 📖

This pull request renames îles plugins to modules to avoid confusion with Vite plugins.

Modules can now be provided as strings, or [string, options] pairs, allowing to conveniently use ESM modules in CJS applications without the need for an async config.

To simplify authoring modules, a base template will be provided. îles modules will always be imported as ESM and expect a default import that instantiates the module.

This pull request also adds official modules:

kbd>@islands/headings</kbd

A module that injects a rehype plugin to parse headings in MDX documents:

🔗 adds an id to headings and injects an anchor tag to link them
🏷 automatically extracts the title from an <h1> and sets frontmatter.title
📖 sets meta.headings to enable rendering sidebars and table of contents

// iles.config.ts
import { defineConfig } from 'iles'

export default defineConfig({
  modules: [
    '@islands/headings',
  ],
})

kbd>@islands/icons</kbd

A module to add and configure unplugin-icons:

✨ autoInstall enabled by default
🧱 configures the unplugin-vue-components resolver automatically
🎨 files in the /icons dir available as a custom icon collection

  modules: [
    '@islands/icons',
  ],

Screenshots 📷

netlify[bot] commented 2 years ago

✔️ Deploy Preview for iles-docs canceled.

🔨 Explore the source changes: 96a962413f7e8d423fca47f01a65dbb3ab83eac8

🔍 Inspect the deploy log: https://app.netlify.com/sites/iles-docs/deploys/61815c0482f6430008425262

netlify[bot] commented 2 years ago

✔️ Deploy Preview for the-vue-point-with-iles canceled.

🔨 Explore the source changes: 96a962413f7e8d423fca47f01a65dbb3ab83eac8

🔍 Inspect the deploy log: https://app.netlify.com/sites/the-vue-point-with-iles/deploys/61815c046e95150007e4311c

ElMassimo / iles