From e8102098efd72c259160e300e69f7d9961062d8d Mon Sep 17 00:00:00 2001 From: adam-saland Date: Fri, 9 Feb 2024 11:04:39 -0500 Subject: [PATCH 1/3] update docs with live launch links --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c9749c7f..72c464a1 100644 --- a/README.md +++ b/README.md @@ -14,22 +14,22 @@ This repository contains examples for common use cases and API implementations. ## Examples -| **Example** | **Description** | -| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| [container-platform-starter](./how-to/container-platform-starter) | This example shows a simple platform with a single view. | -| [create-window](./how-to/create-window) | This example shows how to create a dynamic window or from a manifest. | -| [use-security-realms](./how-to/use-security-realms) | This example shows you security realms work with multiple target environments | -| [use-preloads](./how-to/use-preloads) | This example shows you a number of examples on how preload scripts can be used in your application | -| [use-channel-api](./how-to/use-channel-api) | This example shows you a number of examples on how to use the channel api for messaging | -| [use-dynamic-manifest](./how-to/use-dynamic-manifest) | This example contains examples of generating a manifest file dynamically | -| [integration-excel](./how-to/integration-excel) | This example demonstrates how to integration with Excel using the OpenFin adaptor | -| [use-popup-window](./how-to/use-popup-window/) | This example contains various examples of how to use popup windows | -| [use-window-options](./how-to/use-window-options/) | This example demonstrates the options available for opening windows | -| [use-interop](./how-to/use-interop/) | This example contains various implementations and use cases for the Interop API | -| [use-a-manifest](./how-to/use-a-manifest/) | This example contains various examples of how to use the OpenFin manifest | -| [use-content-creation-rules](./how-to/use-content-creation-rules/) | This example demonstrates how content creation rules can be applied | -| [use-logging-apis](./how-to/use-logging-apis/) | This example shows how to use OpenFin APIs to retrieve logs and send them to a server. | -| [use-launch-external-process](./how-to/use-launch-external-process/) | This example demonstrates how to use the launch external process secure api. | +| **Example** | **Description** | **Live Launch** | +| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------- | +| [container-platform-starter](./how-to/container-platform-starter) | This example shows a simple platform with a single view. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcontainer-platform-starter%2Fmanifest.fin.json) | +| [create-window](./how-to/create-window) | This example shows how to create a dynamic window or from a manifest. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcreate-window%2Fmanifest.fin.json) | +| [use-security-realms](./how-to/use-security-realms) | This example shows you security realms work with multiple target environments | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-security-realms%2Fmanifest.fin.json) | +| [use-preloads](./how-to/use-preloads) | This example shows you a number of examples on how preload scripts can be used in your application | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-basic%2Fmanifest.fin.json) [Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-restart-on-refresh%2Fmanifest.fin.json) | +| [use-channel-api](./how-to/use-channel-api) | This example shows you a number of examples on how to use the channel api for messaging | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-channel-api-issue-commands-to-a-platform%2Fmanifest.fin.json) | +| [use-dynamic-manifest](./how-to/use-dynamic-manifest) | This example contains examples of generating a manifest file dynamically | | +| [integration-excel](./how-to/integration-excel) | This example demonstrates how to integration with Excel using the OpenFin adaptor | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fintegration-excel%2Fmanifest.fin.json) | +| [use-popup-window](./how-to/use-popup-window/) | This example contains various examples of how to use popup windows | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-advanced%2Fmanifest.fin.json) [Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-modal%2Fmanifest.fin.json) [Example 3](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-single-result%2Fmanifest.fin.json) [Example 4](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-multiple-results%2Fmanifest.fin.json) | +| [use-window-options](./how-to/use-window-options/) | This example demonstrates the options available for opening windows | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-window-options%2Fmanifest.fin.json) | +| [use-interop](./how-to/use-interop/) | This example contains various implementations and use cases for the Interop API | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-interop-setup-multi-platform-interop%2Fmanifest.fin.json) | +| [use-a-manifest](./how-to/use-a-manifest/) | This example contains various examples of how to use the OpenFin manifest | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-a-manifest-create-a-single-page-platform%2Fmanifest.fin.json) | +| [use-content-creation-rules](./how-to/use-content-creation-rules/) | This example demonstrates how content creation rules can be applied | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-content-creation-rules%2Fmanifest.fin.json) | +| [use-logging-apis](./how-to/use-logging-apis/) | This example shows how to use OpenFin APIs to retrieve logs and send them to a server. | | +| [use-launch-external-process](./how-to/use-launch-external-process/) | This example demonstrates how to use the launch external process secure api. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-launch-external-process%2Fmanifest.fin.json) | ## Before you get started From b9feefe83cb6ea6b8ee5388018d9532344314c6d Mon Sep 17 00:00:00 2001 From: adam-saland Date: Fri, 9 Feb 2024 11:16:30 -0500 Subject: [PATCH 2/3] update formatting --- .markdownlint.json | 1 + README.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.markdownlint.json b/.markdownlint.json index 2cf77b9f..84408884 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,5 +1,6 @@ { "line-length": false, "MD029": false, + "MD033": false, "MD041": false } diff --git a/README.md b/README.md index 72c464a1..016c71f7 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ This repository contains examples for common use cases and API implementations. | [container-platform-starter](./how-to/container-platform-starter) | This example shows a simple platform with a single view. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcontainer-platform-starter%2Fmanifest.fin.json) | | [create-window](./how-to/create-window) | This example shows how to create a dynamic window or from a manifest. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcreate-window%2Fmanifest.fin.json) | | [use-security-realms](./how-to/use-security-realms) | This example shows you security realms work with multiple target environments | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-security-realms%2Fmanifest.fin.json) | -| [use-preloads](./how-to/use-preloads) | This example shows you a number of examples on how preload scripts can be used in your application | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-basic%2Fmanifest.fin.json) [Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-restart-on-refresh%2Fmanifest.fin.json) | +| [use-preloads](./how-to/use-preloads) | This example shows you a number of examples on how preload scripts can be used in your application | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-basic%2Fmanifest.fin.json)
[Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-restart-on-refresh%2Fmanifest.fin.json) | | [use-channel-api](./how-to/use-channel-api) | This example shows you a number of examples on how to use the channel api for messaging | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-channel-api-issue-commands-to-a-platform%2Fmanifest.fin.json) | | [use-dynamic-manifest](./how-to/use-dynamic-manifest) | This example contains examples of generating a manifest file dynamically | | | [integration-excel](./how-to/integration-excel) | This example demonstrates how to integration with Excel using the OpenFin adaptor | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fintegration-excel%2Fmanifest.fin.json) | -| [use-popup-window](./how-to/use-popup-window/) | This example contains various examples of how to use popup windows | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-advanced%2Fmanifest.fin.json) [Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-modal%2Fmanifest.fin.json) [Example 3](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-single-result%2Fmanifest.fin.json) [Example 4](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-multiple-results%2Fmanifest.fin.json) | +| [use-popup-window](./how-to/use-popup-window/) | This example contains various examples of how to use popup windows | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-advanced%2Fmanifest.fin.json)
[Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-modal%2Fmanifest.fin.json)
[Example 3](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-single-result%2Fmanifest.fin.json)
[Example 4](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-multiple-results%2Fmanifest.fin.json) | | [use-window-options](./how-to/use-window-options/) | This example demonstrates the options available for opening windows | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-window-options%2Fmanifest.fin.json) | | [use-interop](./how-to/use-interop/) | This example contains various implementations and use cases for the Interop API | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-interop-setup-multi-platform-interop%2Fmanifest.fin.json) | | [use-a-manifest](./how-to/use-a-manifest/) | This example contains various examples of how to use the OpenFin manifest | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-a-manifest-create-a-single-page-platform%2Fmanifest.fin.json) | From ed0a8d84bdd6310ba11c294b589d0aa18b3cd20c Mon Sep 17 00:00:00 2001 From: adam-saland Date: Fri, 9 Feb 2024 11:24:54 -0500 Subject: [PATCH 3/3] validate --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 016c71f7..03ec03a8 100644 --- a/README.md +++ b/README.md @@ -14,22 +14,22 @@ This repository contains examples for common use cases and API implementations. ## Examples -| **Example** | **Description** | **Live Launch** | -| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------- | -| [container-platform-starter](./how-to/container-platform-starter) | This example shows a simple platform with a single view. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcontainer-platform-starter%2Fmanifest.fin.json) | -| [create-window](./how-to/create-window) | This example shows how to create a dynamic window or from a manifest. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcreate-window%2Fmanifest.fin.json) | -| [use-security-realms](./how-to/use-security-realms) | This example shows you security realms work with multiple target environments | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-security-realms%2Fmanifest.fin.json) | -| [use-preloads](./how-to/use-preloads) | This example shows you a number of examples on how preload scripts can be used in your application | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-basic%2Fmanifest.fin.json)
[Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-restart-on-refresh%2Fmanifest.fin.json) | -| [use-channel-api](./how-to/use-channel-api) | This example shows you a number of examples on how to use the channel api for messaging | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-channel-api-issue-commands-to-a-platform%2Fmanifest.fin.json) | -| [use-dynamic-manifest](./how-to/use-dynamic-manifest) | This example contains examples of generating a manifest file dynamically | | -| [integration-excel](./how-to/integration-excel) | This example demonstrates how to integration with Excel using the OpenFin adaptor | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fintegration-excel%2Fmanifest.fin.json) | +| **Example** | **Description** | **Live Launch** | +| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [container-platform-starter](./how-to/container-platform-starter) | This example shows a simple platform with a single view. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcontainer-platform-starter%2Fmanifest.fin.json) | +| [create-window](./how-to/create-window) | This example shows how to create a dynamic window or from a manifest. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fcreate-window%2Fmanifest.fin.json) | +| [use-security-realms](./how-to/use-security-realms) | This example shows you security realms work with multiple target environments | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-security-realms%2Fmanifest.fin.json) | +| [use-preloads](./how-to/use-preloads) | This example shows you a number of examples on how preload scripts can be used in your application | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-basic%2Fmanifest.fin.json)
[Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-preloads-restart-on-refresh%2Fmanifest.fin.json) | +| [use-channel-api](./how-to/use-channel-api) | This example shows you a number of examples on how to use the channel api for messaging | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-channel-api-issue-commands-to-a-platform%2Fmanifest.fin.json) | +| [use-dynamic-manifest](./how-to/use-dynamic-manifest) | This example contains examples of generating a manifest file dynamically | | +| [integration-excel](./how-to/integration-excel) | This example demonstrates how to integration with Excel using the OpenFin adaptor | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fintegration-excel%2Fmanifest.fin.json) | | [use-popup-window](./how-to/use-popup-window/) | This example contains various examples of how to use popup windows | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-advanced%2Fmanifest.fin.json)
[Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-modal%2Fmanifest.fin.json)
[Example 3](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-single-result%2Fmanifest.fin.json)
[Example 4](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-popup-window-multiple-results%2Fmanifest.fin.json) | -| [use-window-options](./how-to/use-window-options/) | This example demonstrates the options available for opening windows | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-window-options%2Fmanifest.fin.json) | -| [use-interop](./how-to/use-interop/) | This example contains various implementations and use cases for the Interop API | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-interop-setup-multi-platform-interop%2Fmanifest.fin.json) | -| [use-a-manifest](./how-to/use-a-manifest/) | This example contains various examples of how to use the OpenFin manifest | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-a-manifest-create-a-single-page-platform%2Fmanifest.fin.json) | -| [use-content-creation-rules](./how-to/use-content-creation-rules/) | This example demonstrates how content creation rules can be applied | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-content-creation-rules%2Fmanifest.fin.json) | -| [use-logging-apis](./how-to/use-logging-apis/) | This example shows how to use OpenFin APIs to retrieve logs and send them to a server. | | -| [use-launch-external-process](./how-to/use-launch-external-process/) | This example demonstrates how to use the launch external process secure api. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-launch-external-process%2Fmanifest.fin.json) | +| [use-window-options](./how-to/use-window-options/) | This example demonstrates the options available for opening windows | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-window-options%2Fmanifest.fin.json) | +| [use-interop](./how-to/use-interop/) | This example contains various implementations and use cases for the Interop API | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-interop-setup-multi-platform-interop%2Fmanifest.fin.json) | +| [use-a-manifest](./how-to/use-a-manifest/) | This example contains various examples of how to use the OpenFin manifest | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-a-manifest-create-a-single-page-platform%2Fmanifest.fin.json) | +| [use-content-creation-rules](./how-to/use-content-creation-rules/) | This example demonstrates how content creation rules can be applied | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-content-creation-rules%2Fmanifest.fin.json) | +| [use-logging-apis](./how-to/use-logging-apis/) | This example shows how to use OpenFin APIs to retrieve logs and send them to a server. | | +| [use-launch-external-process](./how-to/use-launch-external-process/) | This example demonstrates how to use the launch external process secure api. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fcontainer-starter%2Fmain%2Fuse-launch-external-process%2Fmanifest.fin.json) | ## Before you get started