Skip to content

Commit

Permalink
added plugins top level node to doc nav
Browse files Browse the repository at this point in the history
  • Loading branch information
hasith committed Aug 31, 2024
1 parent 48ca671 commit da0a6d3
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 7 deletions.
9 changes: 2 additions & 7 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,12 @@ layout: home
nav_order: 2
---

# Installation Guide

{: .no_toc }
# Installation Guide {: .no_toc }

Welcome to the Productled Library Installation Guide. This guide will walk you through the process of setting up and configuring the Productled Library in your project. By following these steps, you'll be able to leverage the powerful features provided by Productled to enhance your application's user experience.

## Table of contents

{: .no_toc .text-delta }
## Table of contents {: .no_toc .text-delta }

1. TOC
{:toc}

## Install the Core Package
Expand Down
24 changes: 24 additions & 0 deletions docs/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Plugins
layout: home
nav_order: 3
---

# Plugins

Productled offers a variety of plugin libraries to extend its capabilities. You can choose and install the plugins that best suit your needs. For example, to install the Spotlight plugin:

```bash
npm install @productled/<plugin-name>
```

Register the plugin with Productled Core at application start.

e.g., in file: index.tsx
``` typescript
productled.registerPlugin(new SpotlightPlugin());
```

## Available Plugins

- [Spotlights Plugin documentation](plugins/spotlights.md)
10 changes: 10 additions & 0 deletions docs/plugins/spotlights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Spotlights
layout: home
parent: Plugins
nav_order: 1
---

# Spotlights

Spotlights are a type of interactive overlay that guides users through your application's features. They are commonly used to introduce new features, highlight important elements, or provide onboarding assistance to users.

0 comments on commit da0a6d3

Please sign in to comment.