Skip to content

Link directly to individual global enums/structs in documentation #9600

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −0
Open

Link directly to individual global enums/structs in documentation #9600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/common/src/components/SlintProperty.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@ const typeInfo = getTypeInfo(typeName);
if (typeInfo.href !== "") {
const base = import.meta.env.BASE_URL;
typeInfo.href = `${base}${typeInfo.href}`;

// For enums and structs, we can assume they have a permalink to their header on the target page.
// (These permalinks are also always lower-case.)
if (typeName == "enum") {
typeInfo.href += "#" + enumName.toLowerCase();
} else if (typeName == "struct") {
typeInfo.href += "#" + structName.toLowerCase();
}
}
const enumContent = await getEnumContent(enumName);
const structContent = await getStructContent(structName);
Expand Down
Loading