Skip to content

Commit b33d632

Browse files
committed
Fix links, asset URLs
1 parent a199c15 commit b33d632

File tree

11 files changed

+35
-14
lines changed

11 files changed

+35
-14
lines changed

docs/.vitepress/config.mts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ import { defineConfig } from 'vitepress'
44
export default defineConfig({
55
title: "Documentation",
66
description: "",
7+
ignoreDeadLinks: [
8+
/^http:\/\/localhost/,
9+
'/unhosted'
10+
],
711

812
themeConfig: {
913
// https://vitepress.dev/reference/default-theme-config

docs/cordova.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ can be as well). But for the remoteStorage connection to work, you need
1818
to provide a page that is accessible via a public URL. This will be used
1919
as the redirect URL during the OAuth flow.
2020

21+
<img src="./images/cordova_oauth.png" height="200" style="height: 360px; margin-left: 3rem; margin-bottom: 3rem; float: right" />
22+
2123
When a user connects their storage, the OAuth dialog will open in an
2224
in-app browser window, set to show the address to prevent phishing
2325
attacks.

docs/dropbox-and-google-drive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Offering Dropbox and Google Drive storage options
22

3-
![Screenshot of the connect-widget choose-backend screen](_images/screenshot-widget-choose.png){width="50%"}
3+
![Screenshot of the connect-widget choose-backend screen](./images/screenshot-widget-choose.png){width="50%"}
44

55
rs.js has optional support for syncing data with Dropbox and Google
66
Drive instead of a RemoteStorage server.

docs/getting-started/connect-widget.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,9 @@ is using the Connect Widget add-on library, which is written and
55
maintained by the rs.js core team.
66

77
This is optional and an easy way to integrate all functionality into your own
8-
UI. It\'s a great way to start with RS app development and can be replaced with
8+
UI. It's a great way to start with RS app development and can be replaced with
99
custom code later on.
1010

11-
::: tip
12-
If you haven\'t seen the widget in action yet, you can try it out with
13-
with [My Favorite Drinks](https://myfavoritedrinks.5apps.com) for example.
14-
:::
15-
1611
## Adding the library
1712

1813
The Connect Widget library is distributed the same way as
@@ -54,7 +49,7 @@ widget.attach('my-parent-element-id');
5449
```
5550

5651
That's it. Now your users can use the widget in order to connect their storage,
57-
and you can listen to the `remoteStorage` instance's events in order to get
52+
and you can listen to the [RemoteStorage][1] instance's events in order to get
5853
informed about connection status, sync progress, errors, and so on.
5954

6055
::: tip
@@ -63,3 +58,5 @@ interface and code, the widget can serve as a useful source code
6358
example. For everything it does, the Connect Widget only uses public
6459
APIs and events of rs.js, which you can also use in your own code.
6560
:::
61+
62+
[1]: ../api/remotestorage/classes/RemoteStorage.html

docs/getting-started/read-and-write-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ client.storeFile('text/plain', 'bar.txt', content)
5151
### The recommended way: using clients in data modules
5252

5353
The recommended way is to use the private and public [BaseClient][2] instances,
54-
which are available in so-called [data modules](../data-modules). Continue to
54+
which are available in so-called [data modules](../data-modules/). Continue to
5555
the next section in order to learn about them.
5656

5757
[1]: ../api/remotestorage/classes/RemoteStorage.html

docs/images/logo.svg

Lines changed: 18 additions & 0 deletions
Loading

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Documentation
33
description: remoteStorage.js Guides & Reference
44
---
55

6-
<img src="../../public/logo.svg" width="80" height="80" style="width: 80px; height: 80px; float: right" />
6+
<img src="./images/logo.svg" width="80" height="80" style="width: 80px; height: 80px; float: right" />
77

88
# remoteStorage.js
99

docs/why.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ uses and manipulates existing data, without building import/export
3535
features or having users start over from scratch.
3636

3737
Even better, you can get advanced capabilities for free by using shared,
38-
open-source [data modules](data-modules), which you can cooperate on with
38+
open-source [data modules](./data-modules/), which you can cooperate on with
3939
other developers.
4040

4141
For example: enable the sharing of files by simply integrating the [shares
@@ -59,7 +59,7 @@ critical bug, there\'s a team of people who will help with fixing it.
5959
rs.js optionally supports Dropbox and Google Drive as storage backends which
6060
users can connect. Conveniently, as an app developer you don\'t have to
6161
implement anything special in order for these backends to work with your code.
62-
Just [configure OAuth app keys](getting-started/dropbox-and-google-drive), and
62+
Just [configure OAuth app keys](./dropbox-and-google-drive), and
6363
your users can choose between 3 different backends to connect. If you're not
64-
using the [connect widget](getting-started/connect-widget), you may need to
64+
using the [connect widget](./getting-started/connect-widget), you may need to
6565
create additional UI for these alternate backends.

0 commit comments

Comments
 (0)