docs: initial version of super-capacitor docs

website/docs/for-super-capacitor/overview.md

@@ -0,0 +1,78 @@
+# Overview
+
+Super Capacitor is a Capacitor plugin designed to allow Capacitor apps to utilize the capabilities of Ionic Portals.
+
+## Install
+
+```bash
+npm install @ionic-enterprise/super-capacitor
+npx cap sync
+```
+
+## Types
+
+### MicroappOptions
+
+The options for configuring your microapp when using [`presentMicroapp`](#presentmicroapp).
+
+```typescript
+interface MicroappOptions {
+  name: string;
+  type: 'push' | 'modal';
+  modalStyle?: 'fullScreen' | 'pageSheet';
+  startDir?: string;
+  initialContext?: InitialContext;
+  liveUpdateConfig?: LiveUpdateConfig;
+}
+```
+
+## Methods
+
+- [`presentMicroapp(options: MicroappOptions)`](#presentmicroapp)
+- [`dismissMicroapp()`](#dismissmicroapp)
+
+### presentMicroapp
+
+```typescript
+presentMicroapp(options: MicroappOptions) => Promise<void>
+```
+
+#### Usage
+
+```typescript
+import { presentMicroapp } from '@ionic-enterprise/super-capacitor/superapp';
+
+presentMicroapp({
+  name: 'checkoutApp',
+  startDir: 'microapps/checkout',
+  type: 'push',
+});
+```
+
+> **_NOTE:_** A TypeScript module resolution Node16, NodeNext, or Bundler is required to recognize Super Capacitor's use of subpath exports.
+
+#### Parameters
+
+| Name      | Type                                  | Description                                                                 |
+| --------- | ------------------------------------- | --------------------------------------------------------------------------- |
+| `options` | [`MicroappOptions`](#microappoptions) | The [`MicroappOptions`](#microappoptions) object to configure the microapp. |
+
+### dismissMicroapp
+
+```typescript
+dismissMicroapp() => Promise<void>
+```
+
+#### Usage
+
+```typescript
+import { dismissMicroapp } from '@ionic-enterprise/super-capacitor/microapp';
+
+dismissMicroapp();
+```
+
+> **_NOTE:_** A TypeScript module resolution Node16, NodeNext, or Bundler is required to recognize Super Capacitor's use of subpath exports.
+
+
+## Plugins
+A microapp can only use plugins installed in its superapp. All superapp plugins are automatically available to its microapps. If a microapp requires a plugin not used by its superapp, that plugin must still be installed in the superapp.

website/docs/for-super-capacitor/presentation-types.md

@@ -0,0 +1,63 @@
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+# Presentation Types
+
+The `type` option within the `MicroappOptions` interface allows you to specify how the microapp will be presented to users. This section of the documentation provides an example of the available presentation types.
+
+## Push
+
+```typescript
+const microappOptions: MicroappOptions = {
+  name: 'Microapp Name';
+  type: 'push';
+}
+```
+
+<em
+  style={{
+    textAlign: 'center',
+    display: 'block',
+  }}
+>
+  <img src={useBaseUrl('/img/super-capacitor/presentation-types/push.gif')} width="300px" />
+</em>
+
+## Modal
+
+### FullScreen
+
+```typescript
+const microappOptions: MicroappOptions = {
+  name: 'Microapp Name';
+  type: 'modal';
+  modalStyle: 'fullScreen';
+}
+```
+
+<em
+  style={{
+    textAlign: 'center',
+    display: 'block',
+  }}
+>
+  <img src={useBaseUrl('/img/super-capacitor/presentation-types/fullscreen.gif')} width="300px" />
+</em>
+
+### PageSheet
+
+```typescript
+const microappOptions: MicroappOptions = {
+  name: 'Microapp Name';
+  type: 'modal';
+  modalStyle: 'pageSheet';
+}
+```
+
+<em
+  style={{
+    textAlign: 'center',
+    display: 'block',
+  }}
+>
+  <img src={useBaseUrl('/img/super-capacitor/presentation-types/pagesheet.gif')} width="300px" />
+</em>