Skip to content

flow: add chapter redirect index pages #1340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MykolaGolubyev merged 2 commits into from
Aug 31, 2025
Merged

flow: add chapter redirect index pages #1340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f837cc3
flow: add chapter redirect index pages
MykolaGolubyev Aug 31, 2025
afb8bb4
fix outside chapters
MykolaGolubyev Aug 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions znai-core/src/main/java/org/testingisdocumenting/znai/structure/TableOfContents.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ public TocItem firstNonIndexPage() {
.orElse(null);
}

public Optional<TocItem> firstPageInChapter(String dirName) {
return tocItems.stream()
.filter(tocItem -> tocItem.getDirName().equals(dirName))
.findFirst();
}

public void removeTocItem(String dirName, String fileNameWithoutExtension) {
tocItems.removeIf(item -> item.match(dirName, fileNameWithoutExtension));
}
Expand Down Expand Up @@ -139,6 +145,13 @@ public List<TocItem> getTocItems() {
return Collections.unmodifiableList(tocItems);
}

public Set<String> getAllDirNames() {
return tocItems.stream()
.map(TocItem::getDirName)
.filter(dirName -> !dirName.isEmpty())
.collect(toSet());
}

public Collection<Path> getResolvedPaths() {
return tocItemByPath.keySet();
}
Expand Down
1 change: 1 addition & 0 deletions znai-docs/znai/release-notes/1.79/add-2025-08-31-index-pages-for-chapters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Add: Generate index.html files for chapters to automatically redirect to the first page
18 changes: 18 additions & 0 deletions znai-website-gen/src/main/java/org/testingisdocumenting/znai/website/WebSite.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import org.testingisdocumenting.znai.utils.JsonUtils;
import org.testingisdocumenting.znai.parser.MarkupParsingConfiguration;
import org.testingisdocumenting.znai.parser.MarkupParsingConfigurations;
import org.testingisdocumenting.znai.utils.ResourceUtils;
import org.testingisdocumenting.znai.website.modifiedtime.FileBasedPageModifiedTime;
import org.testingisdocumenting.znai.website.modifiedtime.PageModifiedTimeStrategy;

Expand Down Expand Up @@ -200,6 +201,7 @@ private void registerPreprocessor() {
public void deploy() {
reportPhase("deploying documentation");
generatePages();
generateChapterIndexRedirectPages();
generateSearchIndex();
generateLlmContent();
deployToc();
Expand Down Expand Up @@ -634,6 +636,22 @@ private void generatePages() {
buildJsonOfAllPages();
}

private void generateChapterIndexRedirectPages() {
reportPhase("generating chapter index redirect pages");

Set<String> dirNames = toc.getAllDirNames();
dirNames.forEach(dirName -> {
toc.firstPageInChapter(dirName).ifPresent((tocItem) -> {
String redirectUrl = docStructure.fullUrl(
tocItem.getDirName() + "/" + tocItem.getFileNameWithoutExtension());
String redirectPage = ResourceUtils.textContent("template/redirect.html")
.replace("${newUrl}", redirectUrl);

deployer.deploy(dirName + "/index.html", redirectPage);
});
});
}

private void generateSearchIndex() {
reportPhase("generating search index");

Expand Down
10 changes: 10 additions & 0 deletions znai-website-gen/src/main/resources/template/redirect.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="0; url=${newUrl}">
<title>redirecting...</title>
</head>
<body>
</body>
</html>