docs: make urls work in both GH repo and GH pages

codepate · Jan 4, 2023 · f51e393 · f51e393
1 parent 6bc4613
commit f51e393
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ Extensive documentation is available [here](https://capacitor-community.github.i
 
 - [Documentation homepage](https://capacitor-community.github.io/contacts/)
 
-- [Installation](https://capacitor-community.github.io/contacts/#/getting-started/installation)
+- [Installation](https://capacitor-community.github.io/contacts/#/getting-started-installation)
 
 - [API reference](https://capacitor-community.github.io/contacts/#/api)
 

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,12 +1,12 @@
 - Getting started
 
-  - [Installation](getting-started/installation.md)
-  - [Quick start](getting-started/quickstart.md)
+  - [Installation](getting-started-installation.md)
+  - [Quick start](getting-started-quickstart.md)
 
 - Guide
 
-  - [Retrieving contacts](guide/retrieving-contacts.md)
-  - [Creating contacts](guide/creating-contacts.md)
-  - [Troubleshooting](guide/troubleshooting.md)
+  - [Retrieving contacts](guide-retrieving-contacts.md)
+  - [Creating contacts](guide-creating-contacts.md)
+  - [Troubleshooting](guide-troubleshooting.md)
 
 - [API Reference](api.md)
diff --git a/docs/getting-started/installation.md → docs/getting-started-installation.md b/docs/getting-started/installation.md → docs/getting-started-installation.md
@@ -51,6 +51,6 @@ Read about [Setting Permissions](https://capacitorjs.com/docs/android/configurat
 
 After you've followed all the installation steps, you can begin implementing this plugin in your code.
 
-- Read the Guides to learn more about specific methods. Such as [retrieving contacts](guide/retrieving-contacts.md?id=retrieving-contacts) or [creating contacts](guide/creating-contacts.md?id=creating-contacts)
+- Read the Guides to learn more about specific methods. Such as [retrieving contacts](guide-retrieving-contacts.md) or [creating contacts](guide-creating-contacts.md)
 - Refer to the [API Reference](api.md#api-reference-🔌) to see all available methods the plugin offers.
 <!-- - Take a look at some examples [here](https://github.com/capacitor-community/contacts-examples). -->
diff --git a/docs/getting-started/quickstart.md → docs/getting-started-quickstart.md b/docs/getting-started/quickstart.md → docs/getting-started-quickstart.md
@@ -1,6 +1,6 @@
 # Quick start
 
-Before you continue, make sure you have followed all the steps from the [Installation section](installation).
+Before you continue, make sure you have followed all the steps from the [Installation section](getting-started-installation.md).
 
 ## Print some data to the console for a list of contacts
 

diff --git a/docs/guide/creating-contacts.md → docs/guide-creating-contacts.md b/docs/guide/creating-contacts.md → docs/guide-creating-contacts.md
diff --git a/docs/guide/retrieving-contacts.md → docs/guide-retrieving-contacts.md b/docs/guide/retrieving-contacts.md → docs/guide-retrieving-contacts.md
@@ -35,7 +35,7 @@ It would thus only return two properties: `contactId` and `name`.
 
 This is done to keep the performance at its best. Because always retrieving all possible fields, would quickly take up a lot of ram when a large number of contacts is present in the device's phonebook.
 
-All fields available for `projection` can be found in the [API reference](/#/api?id=projection).
+All fields available for `projection` can be found in the [API reference](api.md#projection).
 
 !> To be able to request the notes in contract entries in **iOS 13 or later**, your app must have the `com.apple.developer.contacts.notes` entitlement. You can read more about this in the [official Apple documentation](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes).
 

diff --git a/docs/guide/troubleshooting.md → docs/guide-troubleshooting.md b/docs/guide/troubleshooting.md → docs/guide-troubleshooting.md
diff --git a/docs/index.html b/docs/index.html
@@ -20,6 +20,7 @@
       window.$docsify = {
         name: 'Capacitor Plugin for accessing Contacts',
         repo: 'https://github.com/capacitor-community/contacts',
+        auto2top: true,
         coverpage: 'coverpage.md',
         loadSidebar: true,
         subMaxLevel: 4,