@ugoku/astro 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# @ugoku/astro
+
+## 0.1.1
+
+### Patch Changes
+
+- 1fd8164: Add a README to each published package.
+- Updated dependencies [1fd8164]
+  - @ugoku/core@0.1.1
+  - @ugoku/shiki@0.1.1

package/README.md

@@ -0,0 +1,42 @@
+# @ugoku/astro
+
+Astro adapter for [ugoku](https://github.com/ugokujs/ugoku): runnable, editable code snippets for Shiki-highlighted fences, with no server and no DOM/iframe — console output only.
+
+A single integration auto-wires both the `@ugoku/shiki` transformer and the page script, for plain Astro's MPA navigation and `<ClientRouter />` transitions alike. (This is for plain Astro — Astro Starlight replaces Shiki with its own highlighter and needs a separate adapter.)
+
+## Setup
+
+```ts
+// astro.config.mjs
+import { defineConfig } from 'astro/config';
+import { ugoku } from '@ugoku/astro';
+
+export default defineConfig({
+  integrations: [ugoku()],
+});
+```
+
+That's it — no second manual step, no theme file to edit.
+
+## Usage
+
+Add `run` or `run edit` to a fence's info string:
+
+````md
+```js run
+console.log('hello');
+```
+
+```ts run edit
+function add(a: number, b: number): number {
+  return a + b;
+}
+console.log(add(2, 3));
+```
+````
+
+`run` is run-only; `run edit` additionally shows an editable overlay over the highlighted block, with edits persisted to `localStorage` per snippet.
+
+TypeScript blocks (`ts`) have their type annotations stripped in-browser (no type-checking) before execution.
+
+See the [main README](https://github.com/ugokujs/ugoku#readme) for the full picture.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ugoku/astro",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -17,8 +17,8 @@
     "./client": "./src/client.ts"
   },
   "dependencies": {
-    "@ugoku/core": "0.1.0",
-    "@ugoku/shiki": "0.1.0"
+    "@ugoku/core": "0.1.1",
+    "@ugoku/shiki": "0.1.1"
   },
   "devDependencies": {
     "astro": "^5.0.0"