Skip to content

Commit 5e4b2be

Browse files
committed
Update docs
1 parent 99630e7 commit 5e4b2be

File tree

14 files changed

+349
-326
lines changed

14 files changed

+349
-326
lines changed

docs/.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default {
2424
level: [0, 0]
2525
},
2626
lineNumbers: false,
27-
theme: 'css-variables'
27+
theme: 'light-plus'
2828
},
2929

3030
themeConfig: {

docs/external-integration/widgets.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,27 @@
33
PERSCOM.io offers powerful widgets that allow the integration of your organizational data into another website for display. Each widget is a
44
snippet of HTML that can be injected into your website.
55

6+
![Widget Preview](https://raw.githubusercontent.com/DeschutesDesignGroupLLC/perscom-docs/master/resources/widget-preview.png)
7+
68
## Prerequisites
79

810
<!-- prettier-ignore -->
911
::: warning
1012
You must be [subscribed](https://docs.perscom.io/pricing) to the `Pro` plan to use this feature.
1113
:::
1214

15+
## Trying It Out
16+
17+
If you'd like to try the widgets out before using them on your website, you can preview every widget at
18+
[https://widget.perscom.io/](https://widget.perscom.io/). Please note, you must be subscribed to the `Pro` plan to use this feature. Please
19+
have an API key and your PERSCOM ID ready to log in. You can read more about how to access these in the
20+
[Authentication and Authorization](#authentication-and-authorization) section.
21+
22+
<!-- prettier-ignore -->
23+
::: tip
24+
For demonstration purposes, you can select all available scopes for the API key you will use to preview the widgets.
25+
:::
26+
1327
## Choosing The Widget
1428

1529
Each widget uses the same HTML code snippet to display the data. However, to set which widget you would like outputted, you must set the
@@ -105,16 +119,6 @@ the code snippet for it to take affect.
105119
</div>
106120
```
107121

108-
## Externally Accessing The Widget
109-
110-
The PERSCOM.io widget can be accessed outside of the HTML code snippet that you used to post within your website. To see your widget live,
111-
without embedding it in a website, you can visit the URL's below. The `widgetId` corresponds with the [ID](#choosing-the-widget) of the
112-
widget you intend to view. Make sure to set `apiKey` and `perscomId` to the correct values.
113-
114-
```html
115-
https://widget.perscom.io/{widgetId}?apikey={apiKey}&perscomid={perscomId}
116-
```
117-
118122
## Development
119123

120124
The PERSCOM.io Widget project is **open source** and actively looking for developers to participate. If you have experience with frontend

docs/external-integration/widgets/calendar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Below is an example HTML code snippet that will output your calendar.
2828

2929
The following is an example of the calendar widget being displayed within the PERSCOM.io application.
3030

31-
![Widget Calendar Preview](https://perscom-cdn.s3.amazonaws.com/images/calendar-preview-1.png)
31+
![Calendar Preview](https://raw.githubusercontent.com/DeschutesDesignGroupLLC/perscom-docs/master/resources/calendar-preview.png)
3232

3333
## Scopes
3434

docs/external-integration/widgets/forms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ Below is an example HTML code snippet that will output your forms.
5656

5757
The following is an example of the forms widget being displayed within the PERSCOM.io application.
5858

59-
![Widget Forms Preview](https://perscom-cdn.s3.amazonaws.com/images/forms-preview-1.png)
59+
![Form Overview Preview](https://raw.githubusercontent.com/DeschutesDesignGroupLLC/perscom-docs/master/resources/form-preview.png)
6060

61-
![Widget Forms Form Preview](https://perscom-cdn.s3.amazonaws.com/images/forms-preview-2.png)
61+
![Form Preview](https://raw.githubusercontent.com/DeschutesDesignGroupLLC/perscom-docs/master/resources/form-preview-1.png)
6262

6363
## Scopes
6464

docs/external-integration/widgets/roster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ Below is an example HTML code snippet that will output your roster.
2828

2929
The following is an example of the roster widget being displayed within the PERSCOM.io application.
3030

31-
![Widget Roster Preview](https://perscom-cdn.s3.amazonaws.com/images/roster-preview-1.png)
31+
![Roster Preview](https://raw.githubusercontent.com/DeschutesDesignGroupLLC/perscom-docs/master/resources/roster-preview.png)
3232

33-
![Widget Roster User Preview](https://perscom-cdn.s3.amazonaws.com/images/roster-preview-2.png)
33+
![Roster User Preview](https://raw.githubusercontent.com/DeschutesDesignGroupLLC/perscom-docs/master/resources/roster-preview-1.png)
3434

3535
## Scopes
3636

0 commit comments

Comments
 (0)