From ba334dfa3aff51adcb5bd5e904e183aac236e937 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 13 Aug 2024 14:41:06 -0500 Subject: [PATCH] Fix homepage --- .prettierignore | 1 + docs/app.config.ts | 2 +- docs/content/fake-browser/0.installation.md | 6 +- docs/content/index.md | 181 ++++++++++---------- 4 files changed, 93 insertions(+), 97 deletions(-) diff --git a/.prettierignore b/.prettierignore index 1b96990..7349e29 100644 --- a/.prettierignore +++ b/.prettierignore @@ -6,4 +6,5 @@ pnpm-lock.yaml /docs/api/* .nuxt .wxt.output +docs/content/index.md docs/content/*/api.md diff --git a/docs/app.config.ts b/docs/app.config.ts index 8e8639f..f153774 100644 --- a/docs/app.config.ts +++ b/docs/app.config.ts @@ -1,6 +1,6 @@ export default defineAppConfig({ docus: { - title: 'WebExt Core', + title: 'Web Ext Core', description: 'Web Extension Development Made Easy', url: 'http://webext-core.aklinker1.io', github: { diff --git a/docs/content/fake-browser/0.installation.md b/docs/content/fake-browser/0.installation.md index 0cf400c..bfa880b 100644 --- a/docs/content/fake-browser/0.installation.md +++ b/docs/content/fake-browser/0.installation.md @@ -10,11 +10,13 @@ toc: true An in-memory implementation of [`webextension-polyfill`](https://www.npmjs.com/package/webextension-polyfill) for testing. Supports all test frameworks (Vitest, Jest, etc). -```ts +```sh pnpm i -D @webext-core/fake-browser ``` -> This package only really works with projects using node, so only the NPM install steps are shown. +::alrt{type=warning} +This package only really works with projects using node, so only the NPM install steps are shown. +:: See [Testing Frameworks](/fake-browser/testing-frameworks) to setup mocks for your testing framework of choice. diff --git a/docs/content/index.md b/docs/content/index.md index 6a78933..065c114 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -8,16 +8,14 @@ main: :ellipsis{right=0px width=75% blur=150px} -## ::block-hero - +::block-hero +--- cta: - -- Get started -- /get-started/introduction - secondary: -- Open on GitHub → -- https://github.com/aklinker1/webext-core - + - Get started + - /get-started/introduction +secondary: + - Open on GitHub → + - https://github.com/aklinker1/webext-core --- #title @@ -27,22 +25,17 @@ Web extension development made easy Easy-to-use utilities for writing and testing web extensions that work on all browsers. #support -::terminal - ---- - -content: - -- npm i @webext-core/storage -- npm i @webext-core/messaging -- npm i @webext-core/proxy-service -- npm i @webext-core/fake-browser -- npm i @webext-core/job-scheduler -- ... - ---- - -:: + ::terminal + --- + content: + - npm i @webext-core/storage + - npm i @webext-core/messaging + - npm i @webext-core/proxy-service + - npm i @webext-core/fake-browser + - npm i @webext-core/job-scheduler + - ... + --- + :: :: ::card-grid @@ -53,73 +46,73 @@ All Packages :ellipsis{left=0px width=40rem top=10rem blur=140px} #default -::card{icon=noto:optical-disk} -#title -`@webext-core/storage` -#description -An alternative, type-safe API similar to local storage for accessing extension storage. -
-
-[Go to docs →](/storage/installation) -:: - -::card{icon=noto:left-speech-bubble} -#title -`@webext-core/messaging` -#description -A simpler, type-safe API for sending and recieving messages. -
-
-[Go to docs →](/messaging/installation) -:: - -::card{icon=noto:construction-worker} -#title -`@webext-core/job-scheduler` -#description -Easily schedule and manage reoccuring jobs. -
-
-[Go to docs →](/job-scheduler/installation) -:: - -::card{icon=noto:thumbs-up} -#title -`@webext-core/match-patterns` -#description -Utilities for working with match patterns. -
-
-[Go to docs →](/match-patterns/installation) -:: - -::card{icon=noto:oncoming-bus} -#title -`@webext-core/proxy-service` -#description -Call a function, but execute in a different JS context, like the background. -
-
-[Go to docs →](/proxy-service/installation) -:: - -::card{icon=noto:puzzle-piece} -#title -`@webext-core/isolated-element` -#description -Create a container who's styles are isolated from the page's styles. -
-
-[Go to docs →](/isolated-element/installation) -:: - -::card{icon=noto:rocket} -#title -`@webext-core/fake-browser` -#description -An in-memory implementation of webextension-polyfill for testing. -
-
-[Go to docs →](/fake-browser/installation) -:: + ::card{icon=noto:optical-disk} + #title + `@webext-core/storage` + #description + An alternative, type-safe API similar to local storage for accessing extension storage. +
+
+ [Go to docs →](/storage/installation) + :: + + ::card{icon=noto:left-speech-bubble} + #title + `@webext-core/messaging` + #description + A simpler, type-safe API for sending and recieving messages. +
+
+ [Go to docs →](/messaging/installation) + :: + + ::card{icon=noto:construction-worker} + #title + `@webext-core/job-scheduler` + #description + Easily schedule and manage reoccuring jobs. +
+
+ [Go to docs →](/job-scheduler/installation) + :: + + ::card{icon=noto:thumbs-up} + #title + `@webext-core/match-patterns` + #description + Utilities for working with match patterns. +
+
+ [Go to docs →](/match-patterns/installation) + :: + + ::card{icon=noto:oncoming-bus} + #title + `@webext-core/proxy-service` + #description + Call a function, but execute in a different JS context, like the background. +
+
+ [Go to docs →](/proxy-service/installation) + :: + + ::card{icon=noto:puzzle-piece} + #title + `@webext-core/isolated-element` + #description + Create a container who's styles are isolated from the page's styles. +
+
+ [Go to docs →](/isolated-element/installation) + :: + + ::card{icon=noto:rocket} + #title + `@webext-core/fake-browser` + #description + An in-memory implementation of webextension-polyfill for testing. +
+
+ [Go to docs →](/fake-browser/installation) + :: ::