Skip to content
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.

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

Various documentation improvements #175

Merged
merged 3 commits into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
81 changes: 81 additions & 0 deletions docs/ucode.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,24 @@ h1 {
display: flex;
}

h3[id].name:not(h2 + h3) {
margin-top: 2.5rem;
border-top: 1px solid #292929;
padding-top: 1.5rem;
}

h3[id].name:not(h2 + h3) .link-anchor {
top: 1.5rem;
}

.light h3[id].name {
border-color: #ccc;
}

html body {
line-height: 1.5;
}

article .description > ul,
article .description > ol {
list-style: initial;
Expand All @@ -18,3 +36,66 @@ article .description > ol {
background-position: 1rem center;
padding-left: 3rem;
}

section table td:first-child,
section .params td:first-child,
section table thead th:first-child,
section .params thead th:first-child,
section .props thead th:first-child {
border-top-left-radius: .5rem;
border-bottom-left-radius: .5rem;
}

section table td:last-child,
section .params td:last-child,
section table thead th:last-child,
section .params thead th:last-child,
section .props thead th:last-child {
border-top-right-radius: .5rem;
border-bottom-right-radius: .5rem;
}

section .params td,
section .params th,
section .props td,
section .props th,
section th,
section td,
section .details .details-item-container {
padding: .5rem 1rem;
}

section ul,
section ol {
padding-left: 1.5rem;
}

section ul li,
section ol li {
padding: .25rem 0;
}

section p {
margin: .75rem 0;
}

section .details {
border-radius: .5rem;
}

section .pre-div {
margin: 1rem 0;
border-radius: .5rem;
}

.param-type {
font-family: "code";
}

.signature-attributes {
font-variant: sub;
}

.method-member-container > strong + dl.param-type > dt {
display: none;
}
32 changes: 32 additions & 0 deletions docs/ucode.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,36 @@ document.addEventListener('DOMContentLoaded', (ev) => {
if (accordionState == null || accordionState == '{}')
document.querySelectorAll('[data-isopen="false"]')
.forEach(item => item.setAttribute('data-isopen', 'true'));

const moduleName = location.pathname.match(/\/module-(.+)\.html$/)?.[1];

if (moduleName) {
const modulePrefix = `module:${moduleName}.`;

document.querySelectorAll(`a[href^="module-${CSS.escape(moduleName)}."]`).forEach(a => {
if (a.text?.indexOf(modulePrefix) == 0)
a.text = a.text.substring(modulePrefix.length);
});
}

document.querySelectorAll('.param-type, .type-signature').forEach(span => {
let replaced;
do {
replaced = false;
span.innerHTML = span.innerHTML.replace(/\b(Object|Array)\.<((?:(?!&[lg]t;).)+)>/,
(m, t, st) => {
replaced = true;

if (t == 'Object')
return `Object<${st.replace(/,\s*/, ': ')}>`;
else
return `${st}[]`;
});
} while (replaced);
});

document.querySelectorAll('.type-signature').forEach(span => {
span.innerHTML = span.innerHTML.replace(/\(nullable\) (.+)$/,
'$1<span class="signature-attributes">nullable</span>');
});
});
Loading