Skip to content

Commit

Permalink
Add scope for docs root folder
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-wong committed Jan 4, 2024
1 parent 521aa3c commit a7f0138
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ defaults:

# Release notes
- scope:
path: "docs/releases" # Specifies the name of the folder where this version of docs are located.
path: "docs/releases" # Specifies the name of the folder where the release notes are located.
# type: "" # Since this scope uses `collection_dir`, we do not need to specify the type here.
values:
layout: page # Specifies the type of template used from the "_layouts" folder.
Expand All @@ -313,6 +313,19 @@ defaults:
toc_sticky: true
search: true

# Common docs in the `docs` root folder
- scope:
path: "docs" # Specifies the name of the folder where the common docs are located.
# type: "" # Since this scope uses `collection_dir`, we do not need to specify the type here.
values:
layout: page # Specifies the type of template used from the "_layouts" folder.
read_time: false # Shows the average reading time for pages.
share: false # Shows social media buttons to share pages.
sidebar: # Shows side navigation content from `_data/navigation.yml`.
nav: "latest" # Add the version enclosed within quotation marks. If the docs in the navigation is for the latest version of the product, be sure to set `nav:` to `"latest"`. If the docs in the navigation is for a previous version of the product, be sure to set `nav:` to the product version number (e.g., `"3.8"`). That version number must match the set of docs for that product version in `_data/navigation.yml`.
toc: true
toc_sticky: true
search: false

# Hides ScalarDL-related pages (e.g., Helm Charts docs) from search results.
# NOTE: The following method causes a lengthy build time, which occasionally causes the build to remain "In progress" indefinitely. Because of that, it is currently commented out until we find an alternative way to hide specific pages from search results.
Expand Down

0 comments on commit a7f0138

Please sign in to comment.