Is your feature request related to a problem? Please describe.

Currently, Island.js has a cli but it doesn't support inline params, such as island dev docs --port=8080.

Describe the solution you'd like

Support cli inline params and pass on the params to Vite.

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

Detect dead links and give hints during the building process to avoid the problem of links not opening after going online. eg:

Describe the solution you'd like

1. check internal link：by looking up the routing table
2. check external link: the check-links library is used to check whether the external links are properly accessible

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

For example, if I want to use KaTex, the katex.css should be linked on each page, Otherwise, the formula will not render correctly.

Describe the solution you'd like

Maybe supporting template HTML file is one of the solutions.

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [x] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Describe the bug

according to getting started, using pnpm to init the island-app project, then start dev server using "pnpm run dev", terminal output Error [ERR_MODULE_NOT_FOUND] it seems like it is a small bug that needs me to install unocss as devDependencies additionally

Reproduction

• Step1: mkdir island-app && cd island-app
• Step2: npm init -y
• Step3: pnpm add islandjs
• Setp4: mkdir docs && echo '# Hello World' > docs/index.md
• Step5: add islan dev docs as dev-script in package.json
• Step6: pnpm run dev
• reproduce

Expected behavior

start the dev server according to the Getting Started Page without any additional behavior

System Info

System:
    OS: macOS 12.4
    CPU: (8) x64 Apple M1
    Memory: 18.11 MB / 16.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 16.4.0 - ~/.nvm/versions/node/v16.4.0/bin/node
    Yarn: 1.22.10 - ~/.nvm/versions/node/v14.6.0/bin/yarn
    npm: 7.18.1 - ~/.nvm/versions/node/v16.4.0/bin/npm
  Browsers:
    Chrome: 105.0.5195.125
    Firefox: 104.0.2
    Safari: 15.5
  npmPackages:
    islandjs: ^0.2.6 => 0.2.6

Additional context

No response

Validations

• [X] Read the docs
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

Describe the bug

Reproduction

Open the docs website in safari browser.

Expected behavior

When we open the page, the aside marker and appearance button can be interactive.

System Info

-

Additional context

No response

Validations

• [X] Read the docs
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

Describe the bug

According to the official documentation, when initializing the project, when the git repository is not initialized, the execution dev will throw an error directly and the page will not be displayed properly.

Reproduction

1. Quick start to initialize the project with the official documentation
2. Execute pnpm run dev

Expected behavior

Correctly display the startup page

System Info

System:
    OS: macOS 12.6
    CPU: (8) arm64 Apple M1
    Memory: 137.02 MB / 8.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 16.14.2 - /usr/local/bin/node
    Yarn: 1.22.18 - /usr/local/bin/yarn
    npm: 8.19.2 - /usr/local/bin/npm
  Browsers:
    Chrome: 106.0.5249.91
    Safari: 16.0
  npmPackages:
    islandjs: ^0.2.4 => 0.2.4

Additional context

No response

Validations

• [X] Read the docs
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

Without e2e test case, we may dismiss some edge case and have some potential risk before publishing the package, e.g. #49

Describe the solution you'd like

The e2e test will base on Vitest and playwright, referenced vitepress implement. https://github.com/vuejs/vitepress/pull/1012

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Describe the bug

根据 文档 案例 操作过来 ，最后 yarn dev 启动失败

Reproduction

[plugin:vite:import-analysis] Failed to resolve import "D:myCodeislanddocsindex.md" from "virtual:routes". Does the file exist?
32 |  ;
33 |  import React from 'react';
34 |  const Route0 = lazyWithPreload(() => import('D:\myCode\island\docs\index.md'))
   |                                              ^
35 |  export const routes = [
36 |  { path: '/', element: React.createElement(Route0), filePath: 'D:\myCode\island\docs\index.md', preload: Route0.preload }
    at formatError (file:///D:/myCode/island/node_modules/islandjs/node_modules/vite/dist/node/chunks/dep-0fc8e132.js:35330:46)
    at TransformContext.error (file:///D:/myCode/island/node_modules/islandjs/node_modules/vite/dist/node/chunks/dep-0fc8e132.js:35326:19)
    at normalizeUrl (file:///D:/myCode/island/node_modules/islandjs/node_modules/vite/dist/node/chunks/dep-0fc8e132.js:40255:33)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async TransformContext.transform (file:///D:/myCode/island/node_modules/islandjs/node_modules/vite/dist/node/chunks/dep-0fc8e132.js:40389:47)
    at async Object.transform (file:///D:/myCode/island/node_modules/islandjs/node_modules/vite/dist/node/chunks/dep-0fc8e132.js:35579:30)
    at async loadAndTransform (file:///D:/myCode/island/node_modules/islandjs/node_modules/vite/dist/node/chunks

Expected behavior

希望能正常跑通 流程。

System Info

windows 系统

Additional context

No response

Validations

• [X] Read the docs
• [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

Now, island.js does not support last updated show in md ,like this

Describe the solution you'd like

use 'git log' to get the last updated timestamp

Describe alternatives you've considered

No response

Additional context

Now:

Expect:

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

Now, island.js only support react, but sometimes we need other framework such as vue

Describe the solution you'd like

I am not very clear how to refactor the current infrastructure in island.js.But there is a long way to go.

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

Now, BackTop is a boolean config, maybe it can use object to have more control

Describe the solution you'd like

backTop config

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

For example, i want to inject a back to top component, then i can register it by following config:

// config.ts
export default {
  globalUIComponents: ['/User/project/src/components/BackToTop/index.tsx']
}

Then the component will be injected to page automatically.

Describe the solution you'd like

1. declare virtual module in Layout component in default theme.

// Layout/index.tsx
import globalComponents from 'virtual:components'

2. Generate component exports in vite plugin:

load(id) {
  if (id === 'virtual:components') {
    return `
      import BackToTop from '/User/project/src/components/BackToTop/index.tsx';
      export default [BackToTop]
   `
  }
}

3. Render global component:

// Layout/index.tsx
function Layout() {
  return (
     // 省略
     globalComponents.map(globalComponent => React.createElement(globalComponent))
  )
}

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

Is your feature request related to a problem? Please describe.

Now island component can only hang on window object globally and it is difficult if we want to lazyload it.

In Astro, you can lazyload the island component by multi directives:

<ShowHideButton client:idle />
<HeavyImageCarousel client:visible />
<SidebarToggle client:media="(max-width: 50em)" />

So the key is that island component can be loaded dynamically.Then we can use requestIdleCallback, IntersectionObserver API or some custom logic to decide to load the component in proper time.

Describe the solution you'd like

In Island.js, we can implement above feature in these parts:

• Expose more island config to user, such as __island="visible" | "idle" | "media".
• Islands bundle build phase, we should hang the load function instead of component itself so that the component to can be loaded dynamically.
• In client runtime, we should optimize the hydrate script.Base on the island config by user, we choose to load the island component and hydrate it in the proper time.

Describe alternatives you've considered

No response

Additional context

No response

Validations

• [X] Read the docs.
• [X] Read the Contributing Guidelines.
• [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.