diff --git a/.github/workflows/setup/action.yml b/.github/workflows/setup/action.yml index d7697dd5e2..abb221f315 100644 --- a/.github/workflows/setup/action.yml +++ b/.github/workflows/setup/action.yml @@ -11,6 +11,9 @@ inputs: nixOSVersion: type: string default: 22.11 + hugoVersion: + type: string + default: "0.135.0" conanfile: type: string default: cmake/Modules/conan-dissolve.cmake @@ -26,6 +29,7 @@ runs: echo "qtVersion=${{ inputs.qtVersion }}" >> ${GITHUB_ENV} echo "nixVersion=${{ inputs.nixVersion }}" >> ${GITHUB_ENV} echo "nixOSVersion=${{ inputs.nixOSVersion }}" >> ${GITHUB_ENV} + echo "hugoVersion=${{ inputs.hugoVersion }}" >> ${GITHUB_ENV} - name: Get code version shell: bash diff --git a/.github/workflows/website/action.yml b/.github/workflows/website/action.yml index e83fe3a4d2..e7a3777a1c 100644 --- a/.github/workflows/website/action.yml +++ b/.github/workflows/website/action.yml @@ -2,8 +2,6 @@ name: Website description: Build and publish website inputs: - hugoVersion: - default: "0.98.0" isRelease: type: boolean default: false @@ -32,17 +30,18 @@ runs: if: ${{ inputs.isRelease == 'true' && inputs.isLegacy == 'false' }} shell: bash run: | - # Set version in docs index - sed -i 's/vMAJOR.MINOR/Release v${{ env.dissolveMajorVersion }}.${{ env.dissolveMinorVersion }}/g' web/docs/_index.md + # Set version and tip visibility in docs index + sed -i 's/RELEASETYPE version MAJOR.MINOR/Release v${{ env.dissolveMajorVersion }}.${{ env.dissolveMinorVersion }}/g' web/docs/_index.md + sed -i "/RELEASE TIP/d" web/docs/_index.md head -n 10 web/docs/_index.md - name: 'Apply Development Release Styling' if: ${{ inputs.isDevelopment == 'true' }} shell: bash run: | - # Set version and shortcode target in docs index - sed -i 's/vMAJOR.MINOR/Development v${{ env.dissolveMajorVersion }}.${{ env.dissolveMinorVersion }}/g' web/docs/_index.md - sed -i 's/documentationinfo target=".*"/documentationinfo target="development"/g' web/docs/_index.md + # Set version and tip visibility in docs index + sed -i 's/RELEASETYPE version MAJOR.MINOR/Development version ${{ env.dissolveMajorVersion }}.${{ env.dissolveMinorVersion }}/g' web/docs/_index.md + sed -i "/DEVELOPMENT TIP/d" web/docs/_index.md head -n 10 web/docs/_index.md # Change base url @@ -57,9 +56,9 @@ runs: if: ${{ inputs.isLegacy == 'true' }} shell: bash run: | - # Set version and shortcode target in docs index - sed -i 's/vMAJOR.MINOR/Legacy v${{ env.dissolveMajorVersion }}.${{ env.dissolveMinorVersion }}/g' web/docs/_index.md - sed -i 's/documentationinfo target=".*"/documentationinfo target="legacy"/g' web/docs/_index.md + # Set version and tip visibility in docs index + sed -i 's/RELEASETYPE version MAJOR.MINOR/Legacy version ${{ env.dissolveMajorVersion }}.${{ env.dissolveMinorVersion }}/g' web/docs/_index.md + sed -i "/LEGACY TIP/d" web/docs/_index.md head -n 10 web/docs/_index.md # Change base url @@ -74,7 +73,7 @@ runs: shell: bash run: | set -ex - wget https://github.com/gohugoio/hugo/releases/download/v${{ inputs.hugoVersion }}/hugo_extended_${{ inputs.hugoVersion }}_Linux-64bit.deb -O '${{ github.workspace }}/hugo.deb' + wget https://github.com/gohugoio/hugo/releases/download/v${{ env.hugoVersion }}/hugo_extended_${{ env.hugoVersion }}_linux-amd64.deb -O '${{ github.workspace }}/hugo.deb' sudo dpkg -i ${{ github.workspace }}/hugo*.deb - name: 'Install pandoc / xetex' diff --git a/web/.gitignore b/web/.gitignore index 094c0caaca..c8b0fe94de 100644 --- a/web/.gitignore +++ b/web/.gitignore @@ -1,5 +1,6 @@ # Git ignore file for dissolve-web/ public/* +public-docs/* resources/* static/img/*.svg static/img/*.png diff --git a/web/docs.toml b/web/docs.toml index e2fc5c607c..9e89a752e2 100644 --- a/web/docs.toml +++ b/web/docs.toml @@ -54,12 +54,6 @@ github_subdir = "web" github_branch = "develop" offlineSearch = true -# Documentation Index Description -[params.docinfo] -release = "Here you can find the user guide and examples for the current release of Dissolve (vMAJOR.MINOR). Updated documentation for the current development version is [available here](/dev), and documentation for the previous release series can be [found here](/legacy)." -development = "Here you can find the user guide and examples for the current development version of Dissolve (vMAJOR.MINOR), describing any exciting and upcoming new features." -legacy = "Here you can find the user guide and examples for the previous major release series of Dissolve (vMAJOR.MINOR). This should be considered as legacy documentation and will be removed at some point." - # User interface configuration [params.ui] # Set to true to disable breadcrumb navigation. diff --git a/web/docs/_index.md b/web/docs/_index.md index e254ebfb94..6138288232 100755 --- a/web/docs/_index.md +++ b/web/docs/_index.md @@ -1,18 +1,22 @@ --- -title: "Documentation for vMAJOR.MINOR" -linkTitle: "Documentation (vMAJOR.MINOR)" +title: "Documentation for RELEASETYPE version MAJOR.MINOR" +linkTitle: "Documentation (RELEASETYPE version MAJOR.MINOR)" cascade: - type: "docs" --- -{{< documentationinfo target="release" >}} +Here you can find the user guide and examples for the RELEASETYPE version MAJOR.MINOR of Dissolve. +{{< tip text="Documentation for the current release version is [available here](/)" />}} +{{< tip text="Updated documentation for the current development version is [available here](/dev)" />}} +{{< tip text="Documentation for the most recent legacy relese series is [available here](/legacy)." />}} ## Copyright / Contributors © 2024 Team Dissolve and contributors - Dr T. Youngs - Dr A. Washington (January 2020 - present) +- Dr R. Buchanan (September 2023 - present) - D. Nixon (January 2020 - present) - D. Bradley (January 2023 - present) - J. Swift (June 2023 - present) diff --git a/web/go.mod b/web/go.mod index c1a97aad62..cece96127a 100644 --- a/web/go.mod +++ b/web/go.mod @@ -2,4 +2,7 @@ module github.com/disorderedmaterials/dissolve/web go 1.18 -require github.com/google/docsy v0.2.0 // indirect +require ( + github.com/google/docsy v0.10.0 // indirect + github.com/google/docsy/dependencies v0.7.2 // indirect +) diff --git a/web/go.sum b/web/go.sum index 69482d853c..cbed2af808 100644 --- a/web/go.sum +++ b/web/go.sum @@ -1,5 +1,13 @@ github.com/FortAwesome/Font-Awesome v0.0.0-20210804190922-7d3d774145ac/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= github.com/google/docsy v0.2.0 h1:DN6wfyyp2rXsjdV1K3wioxOBTRvG6Gg48wLPDso2lc4= github.com/google/docsy v0.2.0/go.mod h1:shlabwAQakGX6qpXU6Iv/b/SilpHRd7d+xqtZQd3v+8= +github.com/google/docsy v0.10.0 h1:6tMDacPwAyRWNCfvsn/9qGOZDQ8b0aRzjRZvnZPY5dg= +github.com/google/docsy v0.10.0/go.mod h1:c0nIAqmRTOuJ01F85U/wJPQtc3Zj9N58Kea9bOT2AJc= github.com/google/docsy/dependencies v0.2.0/go.mod h1:2zZxHF+2qvkyXhLZtsbnqMotxMukJXLaf8fAZER48oo= +github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI= +github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= github.com/twbs/bootstrap v4.6.1+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/web/layouts/partials/head.html b/web/layouts/partials/head.html index fa018063a4..d69b3c3d06 100644 --- a/web/layouts/partials/head.html +++ b/web/layouts/partials/head.html @@ -12,12 +12,7 @@ {{ partialCached "favicons.html" . }}