Merge pull request #428 from mlange-42/nav-sub-pages

upgrade to docsy v0.4.0

- switch docsy to Hugo Module usage instead of a git submodule
- remove unnecessary docsy template overrides; use "docs" default template for most pages, though the page-meta-links no longer show up on the left sidebar when shrunk now
- show sub-pages in sidebar navigation when top-level page is selected

Author: alee

.github/workflows/gh-pages.yml

@@ -10,35 +10,37 @@ on:
 
 jobs:
   deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: 'recursive'
-          fetch-depth: 0
-
-      - name: Setup Yarn
-        uses: actions/setup-node@v2
-      - run: yarn install
+      - uses: actions/checkout@v3
 
       - name: Read .env hugo version
         id: hugo-version
         run: |
           . ./.env
           echo "::set-output name=HUGO_VERSION::${HUGO_VERSION}"
 
-      - name: Setup Hugo 
+      - name: Add hugo nodejs dependencies
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+
+      - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          # sync versions with docker-compose .env ala 
+          # sync versions with docker-compose .env ala
           # https://github.com/marketplace/actions/hugo-setup#%EF%B8%8F-read-hugo-version-from-file
-          hugo-version: '${{ steps.hugo-version.outputs.HUGO_VERSION }}'
+          hugo-version: "${{ steps.hugo-version.outputs.HUGO_VERSION }}"
           extended: true
 
-      - name: Build
+      - name: Build Hugo site
         env:
           HUGO_ENV: "production"
-        run: hugo --minify
+        run: |
+          yarn install
+          hugo mod init github.com/openmodelingfoundation/openmodelingfoundation.github.io
+          hugo mod get github.com/google/docsy@v0.4.0
+          hugo --minify
 
       - name: Deploy
         if: github.event_name == 'push'

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "themes/docsy"]
-	path = themes/docsy
-	url = https://github.com/google/docsy.git

Dockerfile

@@ -2,11 +2,17 @@ ARG HUGO_VERSION=0.101.0
 ARG DIST_TAG=-ext-ubuntu
 FROM klakegg/hugo:${HUGO_VERSION}${DIST_TAG}
 
+ARG DOCSY_VERSION=v0.4.0
+
 LABEL maintainer="CoMSES Net <support@comses.net>"
 
 WORKDIR /src
-COPY ./package.json ./yarn.lock /src/
+COPY config.toml package.json /src/
+
+RUN git config --global --add safe.directory /src \
+    && hugo mod init github.com/openmodelingfoundation/openmodelingfoundation.github.io \
+    && hugo mod get github.com/google/docsy@${DOCSY_VERSION}
 
-RUN yarn install
+COPY . /src/
 
 CMD ["server"]

Makefile

@@ -18,7 +18,6 @@ commands :
 
 ## build            : build files but do not run a server.
 build : 
-	git submodule update --init --recursive
 	docker-compose build --pull
 
 ## serve            : start and run a local server.

assets/scss/_sidebar-tree-with-links.scss

@@ -1,5 +1,4 @@
 .td-sidebar-nav {
-
     .td-page-meta {
         a {
             display: block;
@@ -8,4 +7,4 @@
             font-weight: $font-weight-medium;
         }
     }
-}
+}

assets/scss/main.scss

@@ -33,7 +33,16 @@
 }
 
 footer {
-    min-height: 150px;
+    min-height: 160px;
+
+    .logo {
+        max-width: 100%;
+        height: 60%;
+    }
+
+    a {
+        color: orange !important;
+    }
 
     a:hover {
         color: white !important;
@@ -63,4 +72,4 @@ footer {
     }
 }
 
-@import "styles_project";
+@import "styles_project";

config.toml

@@ -4,7 +4,8 @@ title = "The Open Modeling Foundation"
 enableRobotsTXT = true
 
 # Hugo allows theme composition (and inheritance). The precedence is from left to right.
-theme = ["docsy"]
+# NB: disabled in favor of module settings https://www.docsy.dev/docs/updating/convert-site-to-module/
+# theme = ["github.com/google/docsy", "github.com/google/docsy/dependencies"]
 
 # Will give values to .Lastmod etc.
 enableGitInfo = true
@@ -33,6 +34,19 @@ pygmentsUseClassic = false
 # See https://help.farbox.com/pygments.html
 pygmentsStyle = "tango"
 
+# module settings
+[module]
+  proxy = "direct"
+  [module.hugoVersion]
+    extended = true
+    min = "0.101.0"
+  [[module.imports]]
+    path = "github.com/google/docsy"
+    disable = false
+  [[module.imports]]
+    path = "github.com/google/docsy/dependencies"
+    disable = false
+
 # Configure how URLs look like per section.
 [permalinks]
 blog = "/:section/:year/:month/:day/:slug/"
@@ -59,7 +73,7 @@ anchor = "smart"
 
 [languages]
 [languages.en]
-title = ""
+title = "The Open Modeling Foundation"
 description = "The Open Modeling Foundation is an alliance of modeling organizations that coordinates and administers a common, community developed body of standards and best practices among diverse communities of modeling scientists."
 languageName ="English"
 # Weight used for sorting.
@@ -74,6 +88,9 @@ time_format_blog = "02.01.2006"
 
 # Everything below this are Site Params
 
+[outputs]
+section = [ "HTML", "RSS" ]
+
 [params]
 
 working_group_request_form = "https://asu.questionpro.com/omf-wg-joinrequest"
@@ -96,7 +113,7 @@ archived_version = false
 # The version number for the version of the docs represented in this doc set.
 # Used in the "version-banner" partial to display a version number for the 
 # current doc set.
-version = "0.1"
+version = "0.4"
 
 # A link to latest version of the docs. Used in the "version-banner" partial to
 # point people to the main doc site.
@@ -128,7 +145,7 @@ offlineSearch = true
 # User interface configuration
 [params.ui]
 # Enable to show the side bar menu in its compact state.
-sidebar_menu_compact = false
+sidebar_menu_compact = true
 #  Set to true to disable breadcrumb navigation.
 breadcrumb_disable = false
 #  Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)

content/en/_index.html

@@ -17,9 +17,11 @@ <h3 class="mb-3 pt-3 font-weight-light">Enabling next generation modeling of hum
     <a class="btn btn-lg btn-outline-light mb-4" href="{{< relref "/standards" >}}">
     Standards <i class="fas fa-lightbulb ml-2"></i>
     </a>
+    <div class="mx-auto mt-5">
+        {{< blocks/link-down color="info" >}}
+    </div>
 </div>
 
-{{< blocks/link-down color="primary-light" >}}
 
 {{< /blocks/cover >}}
 

content/en/about/_index.md

@@ -1,6 +1,8 @@
 ---
 title: About
 linkTitle: About
+cascade:
+- type: "docs"
 menu:
   main:
     weight: 20

content/en/contribute/_index.md

@@ -3,7 +3,8 @@ title: "How to Contribute"
 linkTitle: Contribute
 date: 2020-05-04T10:03:13-07:00
 cascade:
-  github_issue_filter: label:"OMF site info"
+- type: "docs"
+- github_issue_filter: label:"OMF site info"
 menu:
   main:
     weight: 20