From 7743b670ed5e486a4ba6f0b69940209890704ac9 Mon Sep 17 00:00:00 2001 From: Konnor Rogers Date: Mon, 30 Jun 2025 15:32:08 -0400 Subject: [PATCH] update docs (#1095) * update docs * add publish access config * update package-lock --- package-lock.json | 9 +++++---- .../webawesome/docs/docs/experimental/ssr.md | 8 ++++---- packages/webawesome/docs/docs/index.md | 16 ++++++++-------- packages/webawesome/package.json | 5 ++++- 4 files changed, 21 insertions(+), 17 deletions(-) diff --git a/package-lock.json b/package-lock.json index 07b1a7cc1..77c76d79c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -589,6 +589,10 @@ "node": ">=12.17" } }, + "node_modules/@awesome.me/webawesome": { + "resolved": "packages/webawesome", + "link": true + }, "node_modules/@babel/code-frame": { "version": "7.23.5", "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.23.5.tgz", @@ -13587,10 +13591,6 @@ "node": ">= 8" } }, - "node_modules/webawesome": { - "resolved": "packages/webawesome", - "link": true - }, "node_modules/webidl-conversions": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-7.0.0.tgz", @@ -13974,6 +13974,7 @@ } }, "packages/webawesome": { + "name": "@awesome.me/webawesome", "version": "3.0.0-beta.1", "license": "MIT", "dependencies": { diff --git a/packages/webawesome/docs/docs/experimental/ssr.md b/packages/webawesome/docs/docs/experimental/ssr.md index e283b8a91..b80f19217 100644 --- a/packages/webawesome/docs/docs/experimental/ssr.md +++ b/packages/webawesome/docs/docs/experimental/ssr.md @@ -26,8 +26,8 @@ If you're using a bundler, make sure it comes _before_ any components are import // Make sure this import is first. import '@lit-labs/ssr-client/lit-element-hydrate-support.js'; -import 'webawesome/dist/components/button/button.js'; -import 'webawesome/dist/components/input/input.js'; +import '@awesome.me/webawesome/dist/components/button/button.js'; +import '@awesome.me/webawesome/dist/components/input/input.js'; ``` ## Enable Server Rendering @@ -43,7 +43,7 @@ import litPlugin from '@lit-labs/eleventy-plugin-lit'; eleventyConfig.addPlugin(litPlugin, { mode: 'worker', - componentModules: ['webawesome/dist/components/button/button.js', 'webawesome/dist/components/input/input.js'], + componentModules: ['@awesome.me/webawesome/dist/components/button/button.js', '@awesome.me/webawesome/dist/components/input/input.js'], }); ``` @@ -114,4 +114,4 @@ Here are some known issues and things we're still working on. - `@shoelace-style/localize` (our localization library) has no way to set a language currently so it always falls back to `en`. - `` has no fallback if there's no JS besides a blank ``. There's perhaps some backend mechanisms we can use to fetch. But requires altering APIs. Should also have a way to set height / widths, but we don't want to increase pain for SSR users. - `` QR Code will not error on the backend and will render a blank canvas at the appropriate size, but will not render the canvas until the client component connects. -- `setBasePath` and `kit codes` may need reconfiguring to work with SSR. +- `setBasePath` and `kit codes` may need reconfiguring to work with SSR. \ No newline at end of file diff --git a/packages/webawesome/docs/docs/index.md b/packages/webawesome/docs/docs/index.md index df05f5aa9..079fc6cb3 100644 --- a/packages/webawesome/docs/docs/index.md +++ b/packages/webawesome/docs/docs/index.md @@ -83,7 +83,7 @@ You will see files named `chunk.[hash].js` in the `chunks` directory. Never impo ### Installing via npm ```bash -npm install webawesome +npm install @awesome.me/webawesome ``` And then in your JavaScript files, import the components you need. @@ -94,15 +94,15 @@ Web Awesome does not a provide a single import with all Web Awesome components. ```js // import the Web Awesome base stylesheet -import "webawesome/dist/styles/webawesome.css" +import "@awesome.me/webawesome/dist/styles/webawesome.css" // import the default "theme" -import "webawesome/dist/styles/themes/default.css" +import "@awesome.me/webawesome/dist/styles/themes/default.css" // -import "webawesome/dist/components/button/button.js" +import "@awesome.me/webawesome/dist/components/button/button.js" // -import "webawesome/dist/components/input/input.js" +import "@awesome.me/webawesome/dist/components/input/input.js" ``` Once they've been imported, you can use them in your HTML normally. Component imports are located in the "Importing" section of each component's documentation. @@ -130,7 +130,7 @@ Most of the magic behind assets is handled internally by Web Awesome, but if you ```html