test deploying github page

.github/workflows/pages.yml

@@ -8,7 +8,7 @@ name: Deploy Jekyll site to Pages
 
 on:
   push:
-    branches:
+    branches: 
       - "main"
     paths:
       - "docs/**"
@@ -37,21 +37,25 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.3' # Not needed with a .ruby-version file
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
           cache-version: 0 # Increment this number if you need to re-download cached gems
           working-directory: '${{ github.workspace }}/docs'
+
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v3
+
       - name: Build with Jekyll
         # Outputs to the './_site' directory by default
         run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
         env:
           JEKYLL_ENV: production
+
       - name: Upload artifact
         # Automatically uploads an artifact from the './_site' directory by default
         uses: actions/upload-pages-artifact@v1

docs/_config.yml

@@ -1,56 +1,40 @@
 title: Equilipy
 description: A python package for calculating chemical equilibria using CALPHAD approach
+theme: just-the-docs
+
 url: https://ornl.github.io/equilipy/
-baseurl: "/Equilipy/docs"
 
-# Build settings
-markdown: kramdown
-remote_theme: just-the-docs/just-the-docs
-plugins:
-  - jekyll-seo-tag
+aux_links:
+  Equilipy on GitHub: https://github.com/ORNL/Equilipy
 
-# Enable Just the Docs settings
-just_the_docs:
-  aux_links:
-    Template Repository: https://github.com/ORNL/Equilipy
-  # Enable the sidebar
-  nav:
-    - title: "Home"
-      url: /Equilipy/docs/index/
-    - title: "Preinstall"
-      url: /Equilipy/docs/preinstall/
-    - title: "Install"
-      url: /Equilipy/docs/install/
-    - title: "Features and Examples"
-      url: /Equilipy/docs/features/
 
-  # Enable search
-  search_enabled: true
-  search:
-    # Split pages into sections that can be searched individually
-    # Supports 1 - 6, default: 2
-    heading_level: 2
-    # Maximum amount of previews per search result
-    # Default: 3
-    previews: 2
-    # Maximum amount of words to display before a matched word in the preview
-    # Default: 5
-    preview_words_before: 3
-    # Maximum amount of words to display after a matched word in the preview
-    # Default: 10
-    preview_words_after: 3
-    # Set the search token separator
-    # Default: /[\s\-/]+/
-    # Example: enable support for hyphenated search words
-    tokenizer_separator: /[\s/]+/
-    # Display the relative url in search results
-    # Supports true (default) or false
-    rel_url: true
-    # Enable or disable the search button that appears in the bottom right corner of every page
-    # Supports true or false (default)
-    button: false
-    # Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
-    focus_shortcut_key: 'k'
+# Enable search
+search_enabled: true
+search:
+  # Split pages into sections that can be searched individually
+  # Supports 1 - 6, default: 2
+  heading_level: 2
+  # Maximum amount of previews per search result
+  # Default: 3
+  previews: 2
+  # Maximum amount of words to display before a matched word in the preview
+  # Default: 5
+  preview_words_before: 3
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 3
+  # Set the search token separator
+  # Default: /[\s\-/]+/
+  # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results
+  # Supports true (default) or false
+  rel_url: true
+  # Enable or disable the search button that appears in the bottom right corner of every page
+  # Supports true or false (default)
+  button: false
+  # Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
+  focus_shortcut_key: 'k'
 
-  # For copy button on code
+# For copy button on code
   enable_copy_code_button: true

docs/index.md

@@ -55,7 +55,7 @@ our community a poisitive experiences for everyone.
 [equilipy]: https://github.com/ORNL/Equilipy
 [CALPHAD method]: https://calphad.org
 [Thermochimica]: https://github.com/ORNL-CEES/thermochimica
-[preinstall]: https://github.com/ORNL/Equilipy/blob/main/docs/preinstal.mdl
+[preinstall]: https://github.com/ORNL/Equilipy/blob/main/docs/preinstal.md
 [install]: https://github.com/ORNL/Equilipy/blob/main/docs/install.md
 [features]: https://github.com/ORNL/Equilipy/blob/main/docs/features.md
 [polars]: https://docs.pola.rs/