Skip to content

Commit 07aa71d

Browse files
authored
Merge branch '7-update-configuration-to-include-the-docs-subfolder' into main
2 parents e3d6819 + 87b3813 commit 07aa71d

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

_config.yml

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,43 @@ title: 🗣️ Samtale - A sandbox project by [OS2](https://www.os2.eu/)
22
description: Empowering organizations and authorities to collaborate effectively through focused discussions.
33
theme: just-the-docs
44

5+
# Base URL for GitHub Pages
56
url: https://os2sandbox.github.io/sandbox-samtale-documentation/
67

8+
# Auxiliary links
79
aux_links:
810
Samtale is using Zulip: https://zulip.readthedocs.io/en/latest/
911
Issue tracker på Github: https://github.com/OS2sandbox/sandbox-samtale
1012

11-
# Makes Aux links open in a new tab. Default is false
13+
# Makes auxiliary links open in a new tab
1214
aux_links_new_tab: true
1315

1416
# Enable or disable the side/mobile menu globally
15-
# Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
1617
nav_enabled: true
1718

1819
# Sort order for navigation links
19-
# nav_sort: case_insensitive # default, equivalent to nil
2020
nav_sort: case_sensitive # Capital letters sorted before lowercase
2121

22-
2322
# Show navigation error report
24-
nav_error_report: true # default is false/nil.
23+
nav_error_report: true
24+
25+
# Include the "docs" folder in the build
26+
include:
27+
- docs
28+
29+
# Enable the Just the Docs navigation
30+
just_the_docs:
31+
collections:
32+
docs:
33+
output: true # Ensures the "docs" collection is rendered
34+
navigation:
35+
structure: nested # Enables nested navigation for subfolders
2536

37+
# Default settings for files in the "docs" folder
2638
defaults:
2739
- scope:
28-
path: "docs" # an empty string here means all files in the project
40+
path: "docs" # Targets the "docs" folder
2941
type: "pages"
3042
values:
31-
layout: "docs"
32-
nav_exclude: false
43+
layout: "default" # Use the default layout provided by the theme
44+
nav_exclude: false # Include in navigation

docs/architecture.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Project Architecture
1+
---
2+
title: "Project Architecture"
3+
nav_order: 1 # Optional: Controls the order in the navigation
4+
---
5+
6+
7+
#
28

39
> Replace this with a brief introduction to the architecture documentation
410

0 commit comments

Comments
 (0)