docs(*):add docs & custom domain

capsule-org · Jul 1, 2022 · 61b8116 · 61b8116
1 parent db05c23
commit 61b8116
Show file tree

Hide file tree

Showing 6 changed files with 101 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -85,6 +85,6 @@ You can use `.` for the project name to scaffold in the current directory.
 
 ## Preview
 
-![npm-create-cli](./doc/npm-create-cli.png)
-![npm-build](./doc/npm-build.png)
-![crx-preview](./doc/crx-preview.png)
+![npm-create-cli](./docs/npm-create-cli.png)
+![npm-build](./docs/npm-build.png)
+![crx-preview](./docs/crx-preview.png)
diff --git a/doc/crx-preview.png → docs/crx-preview.png b/doc/crx-preview.png → docs/crx-preview.png
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,97 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/icons/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Chrome Extensioin</title>
+    <style>
+      body {
+        max-width: 60rem;
+        margin: 0 auto;
+      }
+      pre {
+        padding: 16px;
+        overflow: auto;
+        font-size: 85%;
+        line-height: 1.45;
+        background-color: #161b22;
+        border-radius: 6px;
+        color: #fff;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Create Chrome Extensioin</h1>
+
+    <img src="https://img.shields.io/npm/v/create-chrome-ext?logo=npm" alt="icon" />
+    <img src="https://img.shields.io/npm/dw/create-chrome-ext" alt="icon" />
+    <img
+      src="https://img.shields.io/github/languages/count/guocaoyi/create-chrome-ext"
+      alt="icon"
+    />
+    <img
+      src="https://github.com/guocaoyi/create-chrome-ext/actions/workflows/npm-publish.yml/badge.svg"
+      alt="icon"
+    />
+    <img src="https://img.shields.io/bitbucket/issues/guocaoyi/create-chrome-ext" alt="icon" />
+    <img src="https://img.shields.io/bitbucket/pr-raw/gucoaoyi/create-chrome-ext" alt="icon" />
+
+    <blockquote>
+      <p dir="auto">Next generation chrome extension generater</p>
+    </blockquote>
+    <ul dir="auto">
+      <li>
+        <g-emoji
+          class="g-emoji"
+          alias="zap"
+          fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/26a1.png"
+          >⚡️</g-emoji
+        >
+        Lightning Fast HMR(use vite2)
+      </li>
+      <li>
+        <g-emoji
+          class="g-emoji"
+          alias="package"
+          fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png"
+          >📦</g-emoji
+        >
+        Optimized Builds
+      </li>
+      <li>
+        <g-emoji
+          class="g-emoji"
+          alias="card_index_dividers"
+          fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png"
+          >🗂</g-emoji
+        >
+        Multiple Framework Support
+      </li>
+      <li>
+        <g-emoji
+          class="g-emoji"
+          alias="books"
+          fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png"
+          >📚</g-emoji
+        >
+        Documentation
+      </li>
+    </ul>
+    <h2 dir="auto"><a id="user-content-installing" href="#installing"></a>Installing</h2>
+    <blockquote>
+      <p dir="auto">Node &gt;= 14.18.0</p>
+    </blockquote>
+    <div class="highlight highlight-source-shell notranslate position-relative overflow-auto">
+      <pre>
+    <span class="pl-c"><span class="pl-c">#</span> with npm</span>
+    <span>λ npm create chrome-ext@latest</span>
+    <span class="pl-c"><span class="pl-c">#</span> or with pnpm</span>
+    <span>λ pnpm create chrome-ext</span>
+    <span class="pl-c"><span class="pl-c">#</span> or with yarn</span>
+    <span>λ yarn create chrome-ext</span>
+    <span class="pl-c"><span class="pl-c">#</span> or with npx</span>
+    <span>λ npx create-chrome-ext</span></pre>
+    </div>
+  </body>
+</html>
diff --git a/doc/npm-build.png → docs/npm-build.png b/doc/npm-build.png → docs/npm-build.png
diff --git a/doc/npm-create-cli.png → docs/npm-create-cli.png b/doc/npm-create-cli.png → docs/npm-create-cli.png
diff --git a/index.js b/index.js
@@ -139,7 +139,7 @@ async function init() {
   let author = '**'
   let template = argv.template || argv.t
 
-  const defaultTargetDir = 'vite-project'
+  const defaultTargetDir = 'crx-app'
   const getProjectName = () => (targetDir === '.' ? path.basename(path.resolve()) : targetDir)
 
   let result = {}