ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-09 21:51:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Upgrade docusaurus

Browse Source
This commit is contained in:
allegroai 2021-05-19 05:19:03 +03:00
parent 010b7ac372
commit c76e46ea03
4 changed files with 3515 additions and 7513 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docusaurus.config.js
View File

@ -215,20 +215,27 @@ module.exports = {
[ [
require.resolve("@easyops-cn/docusaurus-search-local"), require.resolve("@easyops-cn/docusaurus-search-local"),
{ {
// ... Your options. hashed: true,
// `hashed` is recommended as long-term-cache of index file is possible. // whether to index docs pages
hashed: true, indexDocs: true,
docsDir: ["docs"], // must start with "/" and correspond to the routeBasePath configured for the docs plugin
docsRouteBasePath: ["/docs"], // use "/" if you use docs-only-mode
// blogDir: ["tutorials"], // (see https://v2.docusaurus.io/docs/2.0.0-alpha.70/docs-introduction#docs-only-mode)
// blogRouteBasePath: ["/tutorials"], docsRouteBasePath: '/docs',
// For Docs using Chinese, The `language` is recommended to set to: searchResultLimits: 8,
// ``` searchResultContextMaxLength: 50,
language: ["en"],
// ``` // whether to index blog pages
// When applying `zh` in language, please install `nodejieba` in your project. indexBlog: false,
}, //blogRouteBasePath: '/blog',
],
// whether to index static pages
// /404.html is never indexed
indexPages: false,
// language of your documentation, see next section
language: "en",
}],
path.resolve(__dirname, 'src/zoom-plugin') path.resolve(__dirname, 'src/zoom-plugin')
], ],
}; };

10941
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

10
package.json
View File

@ -16,11 +16,11 @@
"prettier:diff": "prettier --config .prettierrc --list-different \"**/*.{js,md}\"" "prettier:diff": "prettier --config .prettierrc --list-different \"**/*.{js,md}\""
}, },
"dependencies": { "dependencies": {
"@cmfcmf/docusaurus-search-local": "^0.5.0", "@cmfcmf/docusaurus-search-local": "^0.6.2",
"@docusaurus/core": "2.0.0-alpha.70", "@docusaurus/core": "^2.0.0-beta.0",
"@docusaurus/plugin-content-blog": "^2.0.0-alpha.72", "@docusaurus/plugin-content-blog": "^2.0.0-beta.0",
"@docusaurus/preset-classic": "2.0.0-alpha.70", "@docusaurus/preset-classic": "2.0.0-beta.0",
"@easyops-cn/docusaurus-search-local": "^0.14.4", "@easyops-cn/docusaurus-search-local": "^0.16.3",
"@mdx-js/react": "^1.6.21", "@mdx-js/react": "^1.6.21",
"clsx": "^1.1.1", "clsx": "^1.1.1",
"medium-zoom": "^1.0.6", "medium-zoom": "^1.0.6",

42
src/css/custom.css
View File

@ -181,17 +181,17 @@ html[data-theme="light"] .hero .button.button--primary{
/* header social icons */ /* header social icons */
.header-ico--github { .header-ico--github {
background-image: url('/docs/latest/img/ico-github.svg'); background-image: url('/img/ico-github.svg');
margin-right: calc(var(--ifm-navbar-item-padding-horizontal) * 2); margin-right: calc(var(--ifm-navbar-item-padding-horizontal) * 2);
} }
.header-ico--twitter { .header-ico--twitter {
background-image: url('/docs/latest/img/ico-twitter.svg'); background-image: url('/img/ico-twitter.svg');
} }
.header-ico--youtube { .header-ico--youtube {
background-image: url('/docs/latest/img/ico-youtube.svg'); background-image: url('/img/ico-youtube.svg');
} }
.header-ico--slack { .header-ico--slack {
background-image: url('/docs/latest/img/ico-slack.svg'); background-image: url('/img/ico-slack.svg');
} }
.header-ico { .header-ico {
width:24px; width:24px;
@ -255,7 +255,7 @@ html[data-theme="light"] .hero .button.button--primary{
html[data-theme="light"] [class^="sidebarLogo"] { html[data-theme="light"] [class^="sidebarLogo"] {
background: url('/docs/latest/img/logo--on-light.svg') 1rem center no-repeat; background: url('/img/logo--on-light.svg') 1rem center no-repeat;
background-size: 6rem; background-size: 6rem;
} }
html[data-theme="light"] [class^="sidebarLogo"] > img { html[data-theme="light"] [class^="sidebarLogo"] > img {
@ -283,7 +283,7 @@ html[data-theme="dark"] .navbar-sidebar {
background-color: #141722; background-color: #141722;
} }
html[data-theme="light"] .navbar-sidebar .navbar__brand { html[data-theme="light"] .navbar-sidebar .navbar__brand {
background: url('/docs/latest/img/logo--on-light.svg') 0 center no-repeat; background: url('/img/logo--on-light.svg') 0 center no-repeat;
background-size: 5.5rem; background-size: 5.5rem;
} }
html[data-theme="light"] .navbar-sidebar .navbar__logo { html[data-theme="light"] .navbar-sidebar .navbar__logo {
@ -315,16 +315,16 @@ html[data-theme="dark"] .navbar-sidebar .menu__link.header-ico--slack:before {
.navbar-sidebar .menu__link.header-ico--slack:hover { .navbar-sidebar .menu__link.header-ico--slack:hover {
background: url('/docs/latest/img/ico-slack.svg') no-repeat center; background: url('/img/ico-slack.svg') no-repeat center;
} }
.navbar-sidebar .menu__link.header-ico--twitter:hover { .navbar-sidebar .menu__link.header-ico--twitter:hover {
background: url('/docs/latest/img/ico-twitter.svg') no-repeat center; background: url('/img/ico-twitter.svg') no-repeat center;
} }
.navbar-sidebar .menu__link.header-ico--github:hover { .navbar-sidebar .menu__link.header-ico--github:hover {
background: url('/docs/latest/img/ico-github.svg') no-repeat center; background: url('/img/ico-github.svg') no-repeat center;
} }
.navbar-sidebar .menu__link.header-ico--youtube:hover { .navbar-sidebar .menu__link.header-ico--youtube:hover {
background: url('/docs/latest/img/ico-youtube.svg') no-repeat center; background: url('/img/ico-youtube.svg') no-repeat center;
} }
.menu__link.header-ico { .menu__link.header-ico {
@ -414,22 +414,22 @@ html[data-theme="dark"] .footer__copyright {
/* social links icons */ /* social links icons */
.footer__link-item[href*="slack"] { .footer__link-item[href*="slack"] {
padding-left: 1.4rem; padding-left: 1.4rem;
background: url('/docs/latest/img/ico-slack.svg') no-repeat left center; background: url('/img/ico-slack.svg') no-repeat left center;
background-size: 1rem; background-size: 1rem;
} }
.footer__link-item[href*="youtube"] { .footer__link-item[href*="youtube"] {
padding-left: 1.4rem; padding-left: 1.4rem;
background: url('/docs/latest/img/ico-youtube.svg') no-repeat left center; background: url('/img/ico-youtube.svg') no-repeat left center;
background-size: 1rem; background-size: 1rem;
} }
.footer__link-item[href*="twitter"] { .footer__link-item[href*="twitter"] {
padding-left: 1.4rem; padding-left: 1.4rem;
background: url('/docs/latest/img/ico-twitter.svg') no-repeat left center; background: url('/img/ico-twitter.svg') no-repeat left center;
background-size: 1rem; background-size: 1rem;
} }
.footer__link-item[href*="stackoverflow"] { .footer__link-item[href*="stackoverflow"] {
padding-left: 1.4rem; padding-left: 1.4rem;
background: url('/docs/latest/img/ico-stackoverflow.svg') no-repeat left center; background: url('/img/ico-stackoverflow.svg') no-repeat left center;
background-size: 1rem; background-size: 1rem;
} }
@ -582,7 +582,7 @@ html[data-theme="light"] .icon {
height: 24px; height: 24px;
transform: rotate(0); transform: rotate(0);
transition: 0.25s; transition: 0.25s;
background: url('/docs/latest/icons/ico-chevron-down.svg') no-repeat center; background: url('/icons/ico-chevron-down.svg') no-repeat center;
} }
/* expansion content */ /* expansion content */
@ -594,23 +594,23 @@ html[data-theme="light"] .icon {
/* icon types */ /* icon types */
/* -> info */ /* -> info */
.cml-expansion-panel.info .cml-expansion-panel-summary:before { .cml-expansion-panel.info .cml-expansion-panel-summary:before {
background-image: url('/docs/latest/icons/ico-info-circle.svg'); background-image: url('/icons/ico-info-circle.svg');
} }
/* -> tips */ /* -> tips */
.cml-expansion-panel.tips .cml-expansion-panel-summary:before { .cml-expansion-panel.tips .cml-expansion-panel-summary:before {
background-image: url('/docs/latest/icons/ico-tips.svg'); background-image: url('/icons/ico-tips.svg');
} }
/* -> alert */ /* -> alert */
.cml-expansion-panel.alert .cml-expansion-panel-summary:before { .cml-expansion-panel.alert .cml-expansion-panel-summary:before {
background-image: url('/docs/latest/icons/ico-alert.svg'); background-image: url('/icons/ico-alert.svg');
} }
/* -> screenshot */ /* -> screenshot */
.cml-expansion-panel.screenshot .cml-expansion-panel-summary:before { .cml-expansion-panel.screenshot .cml-expansion-panel-summary:before {
background-image: url('/docs/latest/icons/ico-image.svg'); background-image: url('/icons/ico-image.svg');
} }
/* -> configuration */ /* -> configuration */
.cml-expansion-panel.configuration .cml-expansion-panel-summary:before { .cml-expansion-panel.configuration .cml-expansion-panel-summary:before {
background-image: url('/docs/latest/icons/ico-config.svg'); background-image: url('/icons/ico-config.svg');
} }
/* light mode */ /* light mode */
@ -701,7 +701,7 @@ html[data-theme="dark"] .alert--info {
/* show visual identification for external links */ /* show visual identification for external links */
.markdown a[href^="https://"] { .markdown a[href^="https://"] {
background: url('/docs/latest/icons/ico-open-in-new.svg') center right no-repeat; background: url('/icons/ico-open-in-new.svg') center right no-repeat;
background-size: 0.9rem; background-size: 0.9rem;
margin-right: 0.4rem; margin-right: 0.4rem;
padding-right: 1rem; padding-right: 1rem;