diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 5707a99f3..0a815fd5d 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -11,27 +11,24 @@ jobs: steps: - uses: actions/checkout@v3 with: - submodules: recursive # Fetch Hugo themes (true OR recursive) fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: - hugo-version: 'latest' + hugo-version: '0.113.0' extended: true - name: Setup Node uses: actions/setup-node@v3 with: - node-version: 16 - - - name: Cache dependencies - uses: actions/cache@v3 - with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- + node-version: '18' + cache: 'npm' + # The action defaults to search for the dependency file (package-lock.json, + # npm-shrinkwrap.json or yarn.lock) in the repository root, and uses its + # hash as a part of the cache key. + # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-data + cache-dependency-path: '**/package-lock.json' - run: npm ci diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index 2617933f6..30fe62b18 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -41,4 +41,13 @@ figcaption, iframe { // Reset the reset for definition list description. dd { margin-left: revert; +} + +@media (min-width: 768px) { + @supports (position: sticky) { + .td-sidebar-nav { + max-height: calc(100vh - 4rem); + padding-top: 15px; + } + } } \ No newline at end of file diff --git a/config.toml b/config.toml index d5dc4f2e3..9e4d188d5 100644 --- a/config.toml +++ b/config.toml @@ -16,6 +16,9 @@ enableMissingTranslationPlaceholders = true # Comment out to enable taxonomies in Docsy # disableKinds = ["taxonomy", "taxonomyTerm"] +# Increase timeout so gh-pages doesn't fail +timeout = '60000' + # You can add your own taxonomies [taxonomies] tag = "tags" @@ -68,8 +71,10 @@ id = "UA-00000000-0" [languages] [languages.en] title = "YMCA Website Services" -description = "The YMCA Website Services Documentation" languageName ="English" +[languages.en.params] +description = "The YMCA Website Services Documentation" + # Weight used for sorting. weight = 1 @@ -130,10 +135,10 @@ github_branch= "main" # gcs_engine_id = "d72aa9b2712488cc3" # Enable Algolia DocSearch -algolia_docsearch = false +algolia_docsearch = true # Enable Lunr.js offline search -offlineSearch = true +offlineSearch = false # Enable syntax highlighting and copy buttons on code blocks with Prism prism_syntax_highlighting = true @@ -152,7 +157,7 @@ navbar_translucent_over_cover_disable = false sidebar_menu_compact = true sidebar_menu_foldable = true # Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) -sidebar_search_disable = false +sidebar_search_disable = true # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. diff --git a/content/en/docs/user-documentation/layout-builder/advanced-options/_index.md b/content/en/docs/user-documentation/layout-builder/advanced-options/_index.md index abc8489a3..0d84dae37 100644 --- a/content/en/docs/user-documentation/layout-builder/advanced-options/_index.md +++ b/content/en/docs/user-documentation/layout-builder/advanced-options/_index.md @@ -10,7 +10,7 @@ A huge amount of configuration is available with Layout Builder components using These options provide customizations of Layout Builder-enabled pages at the Content Type, Page, and Component level. -### Content Type Styles +### Content Type styles **Note:** This configuration may not be accessible to all content editors. Ask an administrator for assistance if necessary. @@ -25,7 +25,7 @@ To access them: - Click **Save layout** -### Page Styles +### Page styles Every Layout Builder-enabled page that you create will allow you to override the default settings. @@ -36,11 +36,11 @@ Every Layout Builder-enabled page that you create will allow you to override the - Choose your configuration options. - Click **Save layout** -### Y Block Styles +### Y Block styles Some blocks have additional styles that can be configured per-block. For these blocks (e.g. Banner, Cards), look for the **Y Styles** section in the [block styles section](#block-styles) and set the options accordingly. -## Layout styles +## Section styles When creating or editing a **Section** you have the option of configuring **Layout**, **Style**, and **Settings**. @@ -48,8 +48,20 @@ When creating or editing a **Section** you have the option of configuring **Layo Support for these options is a work in progress and may require involvement of your development partner. Feel free to experiment with the options. Be sure to follow proper brand guidelines and accessibility practices. -## Block styles +### Layout styles + +In this section you can control the container of the Section. +![Screenshot of the Layout Builder Layout Styles options.](lb-advanced--layout-options.png) +- **Container type** + - **Boxed:** Section is narrower than the header of the page. Good for text-heavy layouts. + - **Full:** Section extends to the edges of the main content container. + - **Edge to Edge:** Section extends to the edges of the page. Good for full-width components like Banners and Ping Pong blocks. +- **Gutters** + - **With Gutters:** Section has left and right padding. Good for most non-full-width containers. + - **Without Gutters:** Section has no left and right padding. Best for Edge to Edge containers. + +## Block styles When creating or configuring a block you have the option of opening the **Style** tab to access additional style options including: - background, diff --git a/content/en/docs/user-documentation/layout-builder/advanced-options/lb-advanced--layout-options.png b/content/en/docs/user-documentation/layout-builder/advanced-options/lb-advanced--layout-options.png new file mode 100644 index 000000000..195a676d1 Binary files /dev/null and b/content/en/docs/user-documentation/layout-builder/advanced-options/lb-advanced--layout-options.png differ diff --git a/content/en/docs/user-documentation/layout-builder/donate/_index.md b/content/en/docs/user-documentation/layout-builder/donate/_index.md index 8970d2ae4..14e297f28 100644 --- a/content/en/docs/user-documentation/layout-builder/donate/_index.md +++ b/content/en/docs/user-documentation/layout-builder/donate/_index.md @@ -33,7 +33,7 @@ If your provider is not listed you can add the form by selecting the **Code** Cu ## Donate Block -The Donate Block can be placed in a full-width container. +The Donate Block can be placed in an [edge-to-edge container](../advanced-options#layout-styles). {{< readfile "../lb-add-block.partial" >}} diff --git a/content/en/docs/user-documentation/layout-builder/location-finder/_index.md b/content/en/docs/user-documentation/layout-builder/location-finder/_index.md index 3e020b0a7..bcfb32323 100644 --- a/content/en/docs/user-documentation/layout-builder/location-finder/_index.md +++ b/content/en/docs/user-documentation/layout-builder/location-finder/_index.md @@ -39,7 +39,7 @@ Y's with many amenities may choose to group them in categories. Once any Ameniti To nest terms: -- Go to the Amenities administration page. +- Go to the Amenities administration page at **Administration** > **Structure** > **Taxonomy** > **Amenities**. - **Add term** to create new parent terms if necessary. - Use the drag handle [✥] to arrange terms into nested groups. diff --git a/go.mod b/go.mod index 2ab9423a5..5383c574b 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module github.com/open-y-subprojects/openy_docs go 1.18 -require github.com/google/docsy v0.5.1 // indirect +require github.com/google/docsy v0.6.0 // indirect diff --git a/go.sum b/go.sum index 253905baf..e2be70c4c 100644 --- a/go.sum +++ b/go.sum @@ -4,7 +4,10 @@ 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.5.1 h1:D/ZdFKiE29xM/gwPwQzmkyXhcbQGkReRS6aGrF7lnYk= github.com/google/docsy v0.5.1/go.mod h1:maoUAQU5H/d+FrZIB4xg1EVWAx7RyFMGSDJyWghm31E= +github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= +github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= github.com/google/docsy/dependencies v0.2.0/go.mod h1:2zZxHF+2qvkyXhLZtsbnqMotxMukJXLaf8fAZER48oo= github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= github.com/twbs/bootstrap v4.6.1+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/layouts/partials/hooks/body-end.html b/layouts/partials/hooks/body-end.html new file mode 100644 index 000000000..5264f2593 --- /dev/null +++ b/layouts/partials/hooks/body-end.html @@ -0,0 +1,7 @@ + + \ No newline at end of file diff --git a/layouts/partials/hooks/head-end.html b/layouts/partials/hooks/head-end.html new file mode 100644 index 000000000..1a7cefe5c --- /dev/null +++ b/layouts/partials/hooks/head-end.html @@ -0,0 +1 @@ +