Merge pull request #395 from skedgo/Update-navigation-and-theme

Update navigation and use remote SkedGo theme

Author: nighthawk

.github/workflows/docs-dryrun.yml

@@ -25,7 +25,8 @@ jobs:
           python --version
           pip install --upgrade pip
           pip install mkdocs
-          pip install pymdown-extensions    
+          pip install pymdown-extensions
+          pip install git+https://github.com/skedgo/skedgo-mkdocs-theme
           mkdocs --version 
           bundle install
 

.github/workflows/docs.yml

@@ -26,6 +26,7 @@ jobs:
           pip install --upgrade pip
           pip install mkdocs
           pip install pymdown-extensions    
+          pip install git+https://github.com/skedgo/skedgo-mkdocs-theme
           mkdocs --version 
           bundle install
 

.github/workflows/swift.yml

@@ -3,7 +3,19 @@ name: Swift
 on:
   push:
     branches: [main]
+    paths:
+      - 'Sources/**'
+      - 'Tests/**'
+      - 'Package.swift'
+      - 'TripKit.xcodeproj/**'
+      - 'Examples/**'
   pull_request:
+    paths:
+      - 'Sources/**'
+      - 'Tests/**'
+      - 'Package.swift'
+      - 'TripKit.xcodeproj/**'
+      - 'Examples/**'
   workflow_dispatch:
 
 jobs:

Scripts/docs/INSTRUCTIONS.md

@@ -0,0 +1,6 @@
+## Instructions
+
+Follow the steps below to build the documentation:
+
+-   Install the MKDocs theme: `pip install git+https://github.com/skedgo/skedgo-mkdocs-theme`
+-   Run the documentation locally: `mkdocs serve --no-strict`

Scripts/docs/mkdocs.yml

@@ -3,26 +3,31 @@ site_author: SkedGo Pty Ltd
 site_description: Documentation of TripKit iOS - the iOS SDK of the TripGo API.
 
 nav:
-- Getting Started: index.md
-- View Controllers: view-controllers.md
-- F.A.Q.: faq.md
-- SDK Reference:
-  - TripKit: TripKit/TripKit.html
-  - TripKitUI: TripKit/TripKitUI.html
-  - TripKitInterApp: TripKit/TripKitInterApp.html
-- API: https://developer.tripgo.com
+    - Getting Started: index.md
+    - View Controllers: view-controllers.md
+    - F.A.Q.: faq.md
+    - SDK Reference:
+          - TripKit: TripKit/TripKit.html
+          - TripKitUI: TripKit/TripKitUI.html
+          - TripKitInterApp: TripKit/TripKitInterApp.html
+    - Developer:
+          - Docs: https://developer.tripgo.com/
+          - API: https://developer.tripgo.com/specs
+          - Android: https://android.developer.tripgo.com
+          - iOS: https://ios.developer.tripgo.com
+          - React: https://react.developer.tripgo.com
+    - SkedGo: https://www.skedgo.com
 
 repo_url: https://github.com/skedgo/tripkit-ios
 docs_dir: source
 strict: true
 theme:
-  name: null
-  custom_dir: 'skedgo_theme'
-  highlightjs: True
+    name: skedgo
+    highlightjs: True
 
 # Disable search, as you might expect it to search the reference, too
 plugins: []
 
 markdown_extensions:
-  - pymdownx.highlight
-  - pymdownx.superfences
+    - pymdownx.highlight
+    - pymdownx.superfences