Docs preview

.gitignore

@@ -3,4 +3,4 @@ node_modules
 yarn.lock
 package-lock.json
 dist
-cache
+cache

deploy.sh

@@ -0,0 +1,10 @@
+# Deploy the docs to the `docs` branch.
+git branch -D docs-preview
+git checkout -b docs-preview
+# sed -i '' '/dist/d' .gitignore
+sed -i '' '/docs\/.vitepress\/lib/d' .gitignore
+# npm run build
+git add .
+git commit -m "Update docs"
+git push origin docs-preview -f
+git checkout -

docs/.vitepress/theme/index.js

@@ -1,6 +1,7 @@
 import DefaultTheme from "vitepress/theme";
 import Layout from "genji-theme-vitepress";
 import { h } from "vue";
+import "../lib/charming-cell.umd.min.js";
 
 // More props: https://genji-md.dev/reference/props
 const props = {

docs/cell/getting-started.md

@@ -1 +1,7 @@
 # Getting Started
+
+> WIP
+
+```bash
+npm install @charming-art/cell
+```

docs/cell/index.md

@@ -1 +1,15 @@
-# Charming Cell
+# Charming Cell
+
+The P5 like JavaScript API for ASCII art.
+
+> [!NOTE]
+> The current next branch is implementing the new proposal API for production use. Please refer to the [python branch](https://github.com/charming-art/charming-cell/tree/python) for the released Python version.
+
+## Resources 📚
+
+- Documentation - https://charmingjs.org/cell/
+- Examples - https://observablehq.com/d/18b3d6f3affff5bb
+
+## License 📄
+
+ISC@Bairui SU

docs/cell/what-is-cell.md

@@ -1 +1,17 @@
 # What is Cell?
+
+```js eval
+cm.cell((ctx) => ({
+  mode: "double",
+  width: 520,
+  height: 520,
+  setup() {
+    for (let t = 0; t <= Math.PI * 2; t += Math.PI / 120) {
+      const x = ctx.cols() / 2 + 12 * Math.cos(t) * Math.cos(t * 3);
+      const y = ctx.rows() / 2 + 12 * Math.sin(t) * Math.cos(t * 3);
+      ctx.stroke(cm.wide("🌟"));
+      ctx.point(x, y);
+    }
+  },
+}));
+```

docs/flow/getting-started.md

@@ -1 +1,7 @@
 # Getting Started
+
+> WIP
+
+```bash
+npm install @charming-art/cell
+```

docs/flow/index.md

@@ -1 +1,3 @@
 # Charming Flow
+
+The functional JavaScript API for graphics.

docs/getting-started.md

@@ -1 +1,7 @@
 # Getting Started
+
+> WIP
+
+```bash
+npm install @charming-art/charming
+```

docs/lodash/index.md

@@ -1 +1,3 @@
 # Charming Lodash
+
+The helpful utils for graphics and geometries.

docs/what-is-charming.md

@@ -1 +1,3 @@
 # What is Charming?
+
+The JavaScript library for tailored creative coding.

package.json

@@ -7,7 +7,8 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
+    "docs:preview": "vitepress preview docs",
+    "docs:deploy": "bash ./deploy.sh"
   },
   "keywords": [],
   "author": "",
@@ -16,4 +17,4 @@
     "genji-theme-vitepress": "^0.2.6",
     "vitepress": "^1.3.4"
   }
-}
+}