Merge branch 'main' of https://github.com/cjhw/island

Author: cjhw

README.md

@@ -0,0 +1,17 @@
+# cai-island
+
+ssg framework based on vite and island architecture
+
+## Install
+
+```shell
+npm i cai-create-island -g
+```
+
+## Usage
+
+add a template project
+
+```bash
+pnpm create-island
+```

packages/create-island/README.md

@@ -0,0 +1,17 @@
+# cai-island
+
+ssg framework based on vite and island architecture
+
+## Install
+
+```shell
+npm i cai-create-island -g
+```
+
+## Usage
+
+add a template project
+
+```bash
+pnpm create-island
+```

packages/island/README.md

@@ -1,166 +1,17 @@
-### 项目文件目录
-<!--filetoc-start-->
-- [.husky](https://github.com/cjhw/island/tree/main/.husky)
-  - [_](https://github.com/cjhw/island/tree/main/.husky/_)
-    - [.gitignore](https://github.com/cjhw/island/tree/main/.husky/_/.gitignore)
-    - [husky.sh](https://github.com/cjhw/island/tree/main/.husky/_/husky.sh)
-  - [commit-msg](https://github.com/cjhw/island/tree/main/.husky/commit-msg)
-  - [pre-commit](https://github.com/cjhw/island/tree/main/.husky/pre-commit)
-- [bin](https://github.com/cjhw/island/tree/main/bin)
-  - [island.js](https://github.com/cjhw/island/tree/main/bin/island.js)
-- [docs](https://github.com/cjhw/island/tree/main/docs)
-  - [build](https://github.com/cjhw/island/tree/main/docs/build)
-    - [assets](https://github.com/cjhw/island/tree/main/docs/build/assets)
-      - [a.f6e0dc5d.js](https://github.com/cjhw/island/tree/main/docs/build/assets/a.f6e0dc5d.js)
-      - [b.1a296dcf.js](https://github.com/cjhw/island/tree/main/docs/build/assets/b.1a296dcf.js)
-      - [b.1b3cd05a.js](https://github.com/cjhw/island/tree/main/docs/build/assets/b.1b3cd05a.js)
-      - [c.6fc84862.js](https://github.com/cjhw/island/tree/main/docs/build/assets/c.6fc84862.js)
-      - [client-entry.8e0977d5.js](https://github.com/cjhw/island/tree/main/docs/build/assets/client-entry.8e0977d5.js)
-      - [client-entry.ea3438a2.css](https://github.com/cjhw/island/tree/main/docs/build/assets/client-entry.ea3438a2.css)
-      - [Counter.8982c913.js](https://github.com/cjhw/island/tree/main/docs/build/assets/Counter.8982c913.js)
-      - [index.8120877b.js](https://github.com/cjhw/island/tree/main/docs/build/assets/index.8120877b.js)
-      - [index.8ba6b484.js](https://github.com/cjhw/island/tree/main/docs/build/assets/index.8ba6b484.js)
-    - [guide](https://github.com/cjhw/island/tree/main/docs/build/guide)
-      - [a.html](https://github.com/cjhw/island/tree/main/docs/build/guide/a.html)
-      - [b.html](https://github.com/cjhw/island/tree/main/docs/build/guide/b.html)
-      - [c.html](https://github.com/cjhw/island/tree/main/docs/build/guide/c.html)
-      - [index.html](https://github.com/cjhw/island/tree/main/docs/build/guide/index.html)
-    - [b.html](https://github.com/cjhw/island/tree/main/docs/build/b.html)
-    - [Counter.html](https://github.com/cjhw/island/tree/main/docs/build/Counter.html)
-    - [index.html](https://github.com/cjhw/island/tree/main/docs/build/index.html)
-  - [guide](https://github.com/cjhw/island/tree/main/docs/guide)
-    - [a.tsx](https://github.com/cjhw/island/tree/main/docs/guide/a.tsx)
-    - [b.tsx](https://github.com/cjhw/island/tree/main/docs/guide/b.tsx)
-    - [c.tsx](https://github.com/cjhw/island/tree/main/docs/guide/c.tsx)
-    - [index.mdx](https://github.com/cjhw/island/tree/main/docs/guide/index.mdx)
-  - [public](https://github.com/cjhw/island/tree/main/docs/public)
-    - [island.png](https://github.com/cjhw/island/tree/main/docs/public/island.png)
-  - [b.tsx](https://github.com/cjhw/island/tree/main/docs/b.tsx)
-  - [config.ts](https://github.com/cjhw/island/tree/main/docs/config.ts)
-  - [Counter.tsx](https://github.com/cjhw/island/tree/main/docs/Counter.tsx)
-  - [index.mdx](https://github.com/cjhw/island/tree/main/docs/index.mdx)
-  - [test.ts](https://github.com/cjhw/island/tree/main/docs/test.ts)
-  - [tsconfig.json](https://github.com/cjhw/island/tree/main/docs/tsconfig.json)
-- [e2e](https://github.com/cjhw/island/tree/main/e2e)
-  - [playground](https://github.com/cjhw/island/tree/main/e2e/playground)
-    - [basic](https://github.com/cjhw/island/tree/main/e2e/playground/basic)
-      - [docs](https://github.com/cjhw/island/tree/main/e2e/playground/basic/docs)
-        - [index.md](https://github.com/cjhw/island/tree/main/e2e/playground/basic/docs/index.md)
-      - [package.json](https://github.com/cjhw/island/tree/main/e2e/playground/basic/package.json)
-      - [pnpm-lock.yaml](https://github.com/cjhw/island/tree/main/e2e/playground/basic/pnpm-lock.yaml)
-  - [index.test.ts](https://github.com/cjhw/island/tree/main/e2e/index.test.ts)
-- [scripts](https://github.com/cjhw/island/tree/main/scripts)
-  - [prepare-e2e.cts](https://github.com/cjhw/island/tree/main/scripts/prepare-e2e.cts)
-- [src](https://github.com/cjhw/island/tree/main/src)
-  - [node](https://github.com/cjhw/island/tree/main/src/node)
-    - [constants](https://github.com/cjhw/island/tree/main/src/node/constants)
-      - [index.ts](https://github.com/cjhw/island/tree/main/src/node/constants/index.ts)
-    - [plugin-island](https://github.com/cjhw/island/tree/main/src/node/plugin-island)
-      - [config.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-island/config.ts)
-      - [indexHtml.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-island/indexHtml.ts)
-    - [plugin-mdx](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx)
-      - [rehypePlugins](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/rehypePlugins)
-        - [preWrapper.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/rehypePlugins/preWrapper.ts)
-        - [shiki.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/rehypePlugins/shiki.ts)
-      - [remarkPlugins](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/remarkPlugins)
-        - [toc.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/remarkPlugins/toc.ts)
-      - [index.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/index.ts)
-      - [pluginMdxHmr.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/pluginMdxHmr.ts)
-      - [pluginMdxRollup.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-mdx/pluginMdxRollup.ts)
-    - [plugin-routes](https://github.com/cjhw/island/tree/main/src/node/plugin-routes)
-      - [fixtures](https://github.com/cjhw/island/tree/main/src/node/plugin-routes/fixtures)
-        - [guide](https://github.com/cjhw/island/tree/main/src/node/plugin-routes/fixtures/guide)
-          - [index.mdx](https://github.com/cjhw/island/tree/main/src/node/plugin-routes/fixtures/guide/index.mdx)
-        - [a.mdx](https://github.com/cjhw/island/tree/main/src/node/plugin-routes/fixtures/a.mdx)
-      - [index.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-routes/index.ts)
-      - [RouteService.test.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-routes/RouteService.test.ts)
-      - [RouteService.ts](https://github.com/cjhw/island/tree/main/src/node/plugin-routes/RouteService.ts)
-    - [__tests__](https://github.com/cjhw/island/tree/main/src/node/__tests__)
-      - [__snapshots__](https://github.com/cjhw/island/tree/main/src/node/__tests__/__snapshots__)
-        - [index.test.ts.snap](https://github.com/cjhw/island/tree/main/src/node/__tests__/__snapshots__/index.test.ts.snap)
-      - [babel-plugin-island.test.ts](https://github.com/cjhw/island/tree/main/src/node/__tests__/babel-plugin-island.test.ts)
-      - [index.test.ts](https://github.com/cjhw/island/tree/main/src/node/__tests__/index.test.ts)
-      - [md.test.ts](https://github.com/cjhw/island/tree/main/src/node/__tests__/md.test.ts)
-    - [babel-plugin-island.ts](https://github.com/cjhw/island/tree/main/src/node/babel-plugin-island.ts)
-    - [build.ts](https://github.com/cjhw/island/tree/main/src/node/build.ts)
-    - [cli.ts](https://github.com/cjhw/island/tree/main/src/node/cli.ts)
-    - [config.ts](https://github.com/cjhw/island/tree/main/src/node/config.ts)
-    - [dev.ts](https://github.com/cjhw/island/tree/main/src/node/dev.ts)
-    - [index.ts](https://github.com/cjhw/island/tree/main/src/node/index.ts)
-    - [unocssOptions.ts](https://github.com/cjhw/island/tree/main/src/node/unocssOptions.ts)
-    - [vitePlugins.ts](https://github.com/cjhw/island/tree/main/src/node/vitePlugins.ts)
-  - [runtime](https://github.com/cjhw/island/tree/main/src/runtime)
-    - [app.tsx](https://github.com/cjhw/island/tree/main/src/runtime/app.tsx)
-    - [client-entry.tsx](https://github.com/cjhw/island/tree/main/src/runtime/client-entry.tsx)
-    - [Content.tsx](https://github.com/cjhw/island/tree/main/src/runtime/Content.tsx)
-    - [hooks.ts](https://github.com/cjhw/island/tree/main/src/runtime/hooks.ts)
-    - [index.ts](https://github.com/cjhw/island/tree/main/src/runtime/index.ts)
-    - [ssr-entry.tsx](https://github.com/cjhw/island/tree/main/src/runtime/ssr-entry.tsx)
-  - [shared](https://github.com/cjhw/island/tree/main/src/shared)
-    - [types](https://github.com/cjhw/island/tree/main/src/shared/types)
-      - [attributify-shims.d.ts](https://github.com/cjhw/island/tree/main/src/shared/types/attributify-shims.d.ts)
-      - [index.ts](https://github.com/cjhw/island/tree/main/src/shared/types/index.ts)
-      - [types.d.ts](https://github.com/cjhw/island/tree/main/src/shared/types/types.d.ts)
-  - [theme-default](https://github.com/cjhw/island/tree/main/src/theme-default)
-    - [components](https://github.com/cjhw/island/tree/main/src/theme-default/components)
-      - [Aside](https://github.com/cjhw/island/tree/main/src/theme-default/components/Aside)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/Aside/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/Aside/index.tsx)
-      - [Button](https://github.com/cjhw/island/tree/main/src/theme-default/components/Button)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/Button/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/Button/index.tsx)
-      - [DocFooter](https://github.com/cjhw/island/tree/main/src/theme-default/components/DocFooter)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/DocFooter/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/DocFooter/index.tsx)
-      - [HomeFeature](https://github.com/cjhw/island/tree/main/src/theme-default/components/HomeFeature)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/HomeFeature/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/HomeFeature/index.tsx)
-      - [HomeHero](https://github.com/cjhw/island/tree/main/src/theme-default/components/HomeHero)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/HomeHero/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/HomeHero/index.tsx)
-      - [Link](https://github.com/cjhw/island/tree/main/src/theme-default/components/Link)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/Link/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/Link/index.tsx)
-      - [Nav](https://github.com/cjhw/island/tree/main/src/theme-default/components/Nav)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/Nav/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/Nav/index.tsx)
-      - [Sidebar](https://github.com/cjhw/island/tree/main/src/theme-default/components/Sidebar)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/Sidebar/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/Sidebar/index.tsx)
-      - [SwitchAppearance](https://github.com/cjhw/island/tree/main/src/theme-default/components/SwitchAppearance)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/components/SwitchAppearance/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/components/SwitchAppearance/index.tsx)
-    - [Layout](https://github.com/cjhw/island/tree/main/src/theme-default/Layout)
-      - [DocLayout](https://github.com/cjhw/island/tree/main/src/theme-default/Layout/DocLayout)
-        - [index.module.scss](https://github.com/cjhw/island/tree/main/src/theme-default/Layout/DocLayout/index.module.scss)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/Layout/DocLayout/index.tsx)
-      - [HomeLayout](https://github.com/cjhw/island/tree/main/src/theme-default/Layout/HomeLayout)
-        - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/Layout/HomeLayout/index.tsx)
-      - [index.tsx](https://github.com/cjhw/island/tree/main/src/theme-default/Layout/index.tsx)
-    - [logic](https://github.com/cjhw/island/tree/main/src/theme-default/logic)
-      - [asideScroll.ts](https://github.com/cjhw/island/tree/main/src/theme-default/logic/asideScroll.ts)
-      - [toggleAppearance.ts](https://github.com/cjhw/island/tree/main/src/theme-default/logic/toggleAppearance.ts)
-      - [useHeaders.ts](https://github.com/cjhw/island/tree/main/src/theme-default/logic/useHeaders.ts)
-      - [usePrevNextPage.ts](https://github.com/cjhw/island/tree/main/src/theme-default/logic/usePrevNextPage.ts)
-    - [styles](https://github.com/cjhw/island/tree/main/src/theme-default/styles)
-      - [base.css](https://github.com/cjhw/island/tree/main/src/theme-default/styles/base.css)
-      - [doc.css](https://github.com/cjhw/island/tree/main/src/theme-default/styles/doc.css)
-      - [vars.css](https://github.com/cjhw/island/tree/main/src/theme-default/styles/vars.css)
-    - [index.ts](https://github.com/cjhw/island/tree/main/src/theme-default/index.ts)
-  - [utils.ts](https://github.com/cjhw/island/tree/main/src/utils.ts)
-- [.commitlintrc.cjs](https://github.com/cjhw/island/blob/main/.commitlintrc.cjs)
-- [.eslintignore](https://github.com/cjhw/island/blob/main/.eslintignore)
-- [.eslintrc.cjs](https://github.com/cjhw/island/blob/main/.eslintrc.cjs)
-- [.gitignore](https://github.com/cjhw/island/blob/main/.gitignore)
-- [.prettierignore](https://github.com/cjhw/island/blob/main/.prettierignore)
-- [.prettierrc](https://github.com/cjhw/island/blob/main/.prettierrc)
-- [filetoc.config.js](https://github.com/cjhw/island/blob/main/filetoc.config.js)
-- [package.json](https://github.com/cjhw/island/blob/main/package.json)
-- [playwright.config.ts](https://github.com/cjhw/island/blob/main/playwright.config.ts)
-- [pnpm-lock.yaml](https://github.com/cjhw/island/blob/main/pnpm-lock.yaml)
-- [README.md](https://github.com/cjhw/island/blob/main/README.md)
-- [template.html](https://github.com/cjhw/island/blob/main/template.html)
-- [tsconfig.json](https://github.com/cjhw/island/blob/main/tsconfig.json)
-- [tsup.config.ts](https://github.com/cjhw/island/blob/main/tsup.config.ts)
-- [vitest.config.ts](https://github.com/cjhw/island/blob/main/vitest.config.ts)
-<!--filetoc-end-->
+# cai-island
+
+ssg framework based on vite and island architecture
+
+## Install
+
+```shell
+npm i cai-create-island -g
+```
+
+## Usage
+
+add a template project
+
+```bash
+pnpm create-island
+```