Skip to content

Commit

Permalink
Merge pull request #90 from built-on-openfin/dev/adam/update-docs
Browse files Browse the repository at this point in the history 
Dev/adam/update docs
  • Loading branch information
@adam-saland
adam-saland authored Feb 9, 2024
2 parents 287bb35 + ed0a8d8 commit 3e2269b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
1 change: 1 addition & 0 deletions .markdownlint.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"line-length": false,
"MD029": false,
"MD033": false,
"MD041": false
}
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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) <br> [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) </br> [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) <br> [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) <br> [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

Expand Down

0 comments on commit 3e2269b

Please sign in to comment.