Skip to content

fix: openapi docs improvements #1344

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
merged 9 commits into from
Dec 12, 2024
Merged

fix: openapi docs improvements #1344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2907768
fix: remove descriptions from generated category index of openapi docs
B4nan Dec 11, 2024
efefd99
fix: hide next/prev buttons from openapi docs pages
B4nan Dec 11, 2024
cb21ef1
fix: render category index pages
B4nan Dec 11, 2024
b9ce4c5
fix: unify sidebar and content badges for method type (post/put/creat…
B4nan Dec 11, 2024
9bfbcf7
chore: fix lint
B4nan Dec 11, 2024
dc6b259
fix: add missing syntax highlighting and use custom language order an…
B4nan Dec 11, 2024
a54e81d
build: enable some of the v3.6 optimizations
B4nan Dec 11, 2024
142d6e4
build: enable rspack
B4nan Dec 11, 2024
5748223
Merge branch 'master' into openapi-docs-fixes
TC-MO Dec 12, 2024
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
47 changes: 40 additions & 7 deletions apify-docs-theme/src/theme/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1709,57 +1709,86 @@ iframe[src*="youtube"] {
top: -1.5px;
}

.get > .menu__link::before {
content: 'get';
.theme-api-markdown .openapi__method-endpoint .badge {
border-inline-start-width: 5px;
padding: 3px 5px 3px 4px;
margin-right: 5px;
}

.get > .menu__link::before,
.theme-api-markdown .openapi__method-endpoint .badge--primary {
background-color: var(--ifm-color-info-contrast-background);
color: var(--ifm-color-info-contrast-foreground);
border-color: var(--ifm-color-info-dark);
}

.get > .menu__link::before {
content: 'get';
}

.post > .menu__link::before {
content: 'post';
}

.post > .menu__link::before,
.theme-api-markdown .openapi__method-endpoint .badge--success {
background-color: var(--ifm-color-success-contrast-background);
color: var(--ifm-color-success-contrast-foreground);
border-color: var(--ifm-color-success-dark);
}

.delete > .menu__link::before {
content: 'del';
}

.delete > .menu__link::before,
.theme-api-markdown .openapi__method-endpoint .badge--danger {
background-color: var(--ifm-color-danger-contrast-background);
color: var(--ifm-color-danger-contrast-foreground);
border-color: var(--ifm-color-danger-dark);
}

.put > .menu__link::before {
content: 'put';
}

.put > .menu__link::before,
.theme-api-markdown .openapi__method-endpoint .badge--info {
background-color: var(--ifm-color-warning-contrast-background);
color: var(--ifm-color-warning-contrast-foreground);
border-color: var(--ifm-color-warning-dark);
}

.patch > .menu__link::before {
content: 'patch';
}

.patch > .menu__link::before,
.theme-api-markdown .openapi__method-endpoint .badge--warning {
background-color: var(--ifm-color-success-contrast-background);
color: var(--ifm-color-success-contrast-foreground);
border-color: var(--ifm-color-success-dark);
}

.head > .menu__link::before {
content: 'head';
}

.head > .menu__link::before,
.event > .menu__link::before,
.schema > .menu__link::before,
.theme-api-markdown .openapi__method-endpoint .badge--secondary {
background-color: var(--ifm-color-secondary-contrast-background);
color: var(--ifm-color-secondary-contrast-foreground);
border-color: var(--ifm-color-secondary-dark);
}

.event > .menu__link::before {
content: 'event';
background-color: var(--ifm-color-secondary-contrast-background);
color: var(--ifm-color-secondary-contrast-foreground);
border-color: var(--ifm-color-secondary-dark);
}

.schema > .menu__link::before {
content: 'schema';
.event > .menu__link::before,
.theme-api-markdown .openapi__method-endpoint .badge--secondary {
background-color: var(--ifm-color-secondary-contrast-background);
color: var(--ifm-color-secondary-contrast-foreground);
border-color: var(--ifm-color-secondary-dark);
Expand All @@ -1770,6 +1799,10 @@ iframe[src*="youtube"] {
margin-bottom: calc(var(--ifm-h1-vertical-rhythm-bottom)* var(--ifm-leading)) !important;
}

.theme-doc-markdown .openapi-tabs__code-container .openapi-tabs__code-item span {
text-transform: none;
}

@media (max-width: 996px) {
div[class^="navbarSearchContainer"] {
position: static;
Expand Down
143 changes: 138 additions & 5 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,16 @@ module.exports = {
organizationName: 'apify',
projectName: 'apify-docs',
scripts: ['/js/custom.js'],
// future: {
// experimental_faster: true,
// },
future: {
experimental_faster: {
// swcJsLoader: true,
swcJsMinimizer: true,
swcHtmlMinimizer: true,
lightningCssMinimizer: true,
rspackBundler: true,
mdxCrossCompilerCache: true,
},
},
headTags: [
{
tagName: 'link',
Expand Down Expand Up @@ -190,11 +197,12 @@ module.exports = {
outputDir: './sources/api',
sidebarOptions: {
groupPathsBy: 'tag',
categoryLinkSource: 'tag',
sidebarCollapsed: false,
sidebarCollapsible: false,
sidebarGenerators: {
createDocItem: (item, context) => {
const legacyUrls = item.api['x-legacy-doc-urls'] ?? [];
const legacyUrls = item.api?.['x-legacy-doc-urls'] ?? [];
const altIds = legacyUrls.map((url) => {
const { hash } = new URL(url);
return hash;
Expand Down Expand Up @@ -267,6 +275,11 @@ module.exports = {
parseFrontMatter: async (params) => {
const result = await params.defaultParseFrontMatter(params);

if (result.frontMatter.api || result.content.startsWith('<span class="openapi-clients-box">')) {
result.frontMatter.pagination_next = null;
result.frontMatter.pagination_prev = null;
}

if (result.frontMatter.id === 'apify-api') {
result.frontMatter.slug = '/';
}
Expand All @@ -282,7 +295,127 @@ module.exports = {
return result;
},
},
themeConfig: config.themeConfig,
themeConfig: {
...config.themeConfig,
prism: {
...config.themeConfig.prism,
additionalLanguages: [
...config.themeConfig.prism.additionalLanguages,
'http', 'bash', 'ruby', 'java', 'scala', 'go', 'csharp', 'powershell', 'dart', 'objectivec', 'ocaml', 'r',
],
},
languageTabs: [
{
highlight: 'javascript',
label: 'JavaScript',
language: 'javascript',
logoClass: 'javascript',
},
{
highlight: 'python',
label: 'Python',
language: 'python',
logoClass: 'python',
},
{
highlight: 'bash',
label: 'cURL',
language: 'curl',
logoClass: 'curl',
},
{
highlight: 'php',
label: 'PHP',
language: 'php',
logoClass: 'php',
},
{
highlight: 'java',
label: 'Java',
language: 'java',
logoClass: 'java',
variant: 'unirest',
},
{
highlight: 'c',
label: 'C',
language: 'c',
logoClass: 'c',
},
{
highlight: 'csharp',
label: 'C#',
language: 'csharp',
logoClass: 'csharp',
},
{
highlight: 'go',
label: 'Go',
language: 'go',
logoClass: 'go',
},
{
highlight: 'rust',
label: 'Rust',
language: 'rust',
logoClass: 'rust',
},
{
highlight: 'javascript',
label: 'Node.js',
language: 'nodejs',
logoClass: 'nodejs',
},
{
highlight: 'ruby',
label: 'Ruby',
language: 'ruby',
logoClass: 'ruby',
},
{
highlight: 'powershell',
label: 'PowerShell',
language: 'powershell',
logoClass: 'powershell',
},
{
highlight: 'dart',
label: 'Dart',
language: 'dart',
logoClass: 'dart',
},
{
highlight: 'objectivec',
label: 'Objective-C',
language: 'objective-c',
logoClass: 'objective-c',
},
{
highlight: 'ocaml',
label: 'OCaml',
language: 'ocaml',
logoClass: 'ocaml',
},
{
highlight: 'r',
label: 'R',
language: 'r',
logoClass: 'r',
},
{
highlight: 'swift',
label: 'Swift',
language: 'swift',
logoClass: 'swift',
},
{
highlight: 'kotlin',
label: 'Kotlin',
language: 'kotlin',
logoClass: 'kotlin',
},
],
},
staticDirectories: ['apify-docs-theme/static', 'static'],
customFields: {
forbiddenGiscusDocRegExpStrings: [
Expand Down
Loading
Loading