@apify/docs-theme 1.0.4 → 1.0.6

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@apify/docs-theme",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "",
   "main": "./src/index.js",
   "files": [
-    "src"
+    "src",
+    "types"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -15,6 +16,7 @@
   "license": "ISC",
   "dependencies": {
     "@docusaurus/theme-common": "^2.2.0",
-    "babel-loader": "^9.1.0"
+    "babel-loader": "^9.1.0",
+    "prism-react-renderer": "^1.3.5"
   }
 }

package/src/config.js

@@ -0,0 +1,218 @@
+const absoluteUrl = process.env.LOCAL ? 'http://docs-v2.apify.loc' : 'https://docs-v2.apify.com';
+
+const themeConfig = ({
+    docs: {
+        versionPersistence: 'localStorage',
+        sidebar: {
+            hideable: true,
+        },
+    },
+    navbar: {
+        hideOnScroll: true,
+        title: 'Apify Docs',
+        logo: {
+            src: 'img/apify_sdk.svg',
+            srcDark: 'img/apify_sdk_white.svg',
+            href: absoluteUrl,
+            target: '_self',
+        },
+        items: [
+            {
+                label: 'Academy',
+                href: `${absoluteUrl}/academy`,
+                activeBasePath: 'academy',
+                position: 'left',
+                target: '_self',
+                rel: 'dofollow',
+            },
+            {
+                label: 'Platform',
+                href: `${absoluteUrl}/platform`,
+                className: 'navbar__active',
+                activeBasePath: 'platform',
+                position: 'left',
+                target: '_self',
+                rel: 'dofollow',
+            },
+            {
+                label: 'API',
+                type: 'dropdown',
+                activeBasePath: 'api',
+                position: 'left',
+                items: [
+                    {
+                        label: 'Reference',
+                        // TODO
+                        href: 'https://docs.apify.com/api/v2',
+                    },
+                    {
+                        label: 'Client for JavaScript',
+                        href: `${absoluteUrl}/client-js/`, // we need a trailing slash here, we'd get redirected there anyway
+                        target: '_self',
+                        rel: 'dofollow',
+                    },
+                    {
+                        label: 'Client for Python',
+                        href: `${absoluteUrl}/client-python/`, // we need a trailing slash here, we'd get redirected there anyway
+                        target: '_self',
+                        rel: 'dofollow',
+                    },
+                ],
+            },
+            {
+                label: 'SDK',
+                type: 'dropdown',
+                activeBasePath: 'sdk',
+                position: 'left',
+                items: [
+                    {
+                        label: 'SDK for JavaScript',
+                        href: `${absoluteUrl}/sdk-js/`, // we need a trailing slash here, we'd get redirected there anyway
+                        target: '_self',
+                        rel: 'dofollow',
+                    },
+                    {
+                        label: 'SDK for Python',
+                        href: `${absoluteUrl}/sdk-python/`, // we need a trailing slash here, we'd get redirected there anyway
+                        target: '_self',
+                        rel: 'dofollow',
+                    },
+                ],
+            },
+            {
+                label: 'CLI',
+                href: `${absoluteUrl}/cli/`, // we need a trailing slash here, we'd get redirected there anyway
+                position: 'left',
+                target: '_self',
+                rel: 'dofollow',
+            },
+            {
+                label: 'Open Source',
+                type: 'dropdown',
+                position: 'left',
+                className: 'navbar__item',
+                items: [
+                    {
+                        label: 'Crawlee',
+                        href: 'https://crawlee.dev',
+                        rel: 'dofollow',
+                    },
+                    {
+                        label: 'Got Scraping',
+                        href: 'https://github.com/apify/got-scraping',
+                    },
+                    {
+                        label: 'Fingerprint Suite',
+                        href: 'https://github.com/apify/fingerprint-suite',
+                    },
+                    {
+                        label: 'See our GitHub',
+                        href: 'https://github.com/apify',
+                    },
+                ],
+            },
+            {
+                href: 'https://github.com/apify',
+                label: 'GitHub',
+                title: 'See our GitHub',
+                position: 'right',
+                className: 'icon',
+            },
+            {
+                href: 'https://discord.com/invite/jyEM2PRvMU',
+                label: 'Discord',
+                title: 'Chat on Discord',
+                position: 'right',
+                className: 'icon',
+            },
+        ],
+    },
+    colorMode: {
+        defaultMode: 'light',
+        disableSwitch: false,
+        respectPrefersColorScheme: true,
+    },
+    prism: {
+        defaultLanguage: 'typescript',
+        theme: require('prism-react-renderer/themes/github'),
+        darkTheme: require('prism-react-renderer/themes/dracula'),
+        additionalLanguages: ['docker', 'log'],
+    },
+    metadata: [],
+    image: 'https://apify.com/img/og/docs.png',
+    footer: {
+        links: [
+            {
+                title: 'Docs',
+                items: [
+                    {
+                        label: 'Academy',
+                        to: 'academy',
+                    },
+                    {
+                        label: 'Platform',
+                        to: 'platform',
+                    },
+                ],
+            },
+            {
+                title: 'Community',
+                items: [
+                    {
+                        label: 'Discord',
+                        href: 'https://discord.com/invite/jyEM2PRvMU',
+                    },
+                    {
+                        label: 'Stack Overflow',
+                        href: 'https://stackoverflow.com/questions/tagged/apify',
+                    },
+                    {
+                        label: 'Twitter',
+                        href: 'https://twitter.com/apify',
+                    },
+                ],
+            },
+            {
+                title: 'More',
+                items: [
+                    {
+                        label: 'Apify Platform',
+                        href: 'https://apify.com',
+                    },
+                    {
+                        label: 'Crawlee',
+                        href: 'https://crawlee.dev',
+                    },
+                    {
+                        label: 'Docusaurus',
+                        href: 'https://docusaurus.io',
+                    },
+                    {
+                        label: 'GitHub',
+                        href: 'https://github.com/apify',
+                    },
+                ],
+            },
+        ],
+        logo: {
+            src: 'img/apify_logo.svg',
+            href: '/',
+            width: '60px',
+            height: '60px',
+        },
+    },
+    // TODO
+    algolia: {
+        appId: 'N8EOCSBQGH',
+        apiKey: 'b43e67a96ed18c7f63f5fd965906a96d', // search only (public) API key
+        indexName: 'apify_sdk',
+        algoliaOptions: {
+            facetFilters: ['version:VERSION'],
+        },
+    },
+});
+
+module.exports = {
+    themeConfig,
+    absoluteUrl,
+};

package/src/index.js

@@ -1,41 +1,7 @@
-function theme(
-    context,
-    options,
-) {
-    return {
-        name: '@apify/docs-theme',
-        getThemePath() {
-            return '../src/theme';
-        },
-        getTypeScriptThemePath() {
-            return '../src/theme';
-        },
-        contentLoaded({ actions }) {
-            const { setGlobalData } = actions;
-            setGlobalData({
-                options,
-            });
-        },
-        getClientModules() {
-            return [
-                require.resolve('./theme/custom.css'),
-            ];
-        },
-        configureWebpack() {
-            return {
-                module: {
-                    rules: [
-                        {
-                            test: /(@apify\/|apify-)docs-theme\/src\/theme\/.*?\.jsx?$/,
-                            use: {
-                                loader: 'babel-loader',
-                            },
-                        },
-                    ],
-                },
-            };
-        },
-    };
-}
+const config = require('./config.js');
+const { theme } = require('./theme.js');
 
-exports.default = theme;
+module.exports = {
+    default: theme,
+    config,
+};

package/src/theme/Navbar/Content/index.jsx

@@ -37,17 +37,16 @@ function NavbarContentLayout({
 
 function SubNavbar() {
     const { options: { subNavbar } } = usePluginData('@apify/docs-theme');
-    const pageTitle = useDocusaurusContext().siteConfig.title;
     return (
         subNavbar ? (
             <div className="navbar__inner">
                 <div className="navbar__items">
                     <NavbarItems items={[
                         {
-                            label: pageTitle,
+                            label: subNavbar.title,
                             to: '/',
                         },
-                        ...subNavbar,
+                        ...subNavbar.items,
                     ]}/>
                 </div>
             </div>

package/src/theme/custom.css

@@ -126,6 +126,10 @@ html[data-theme="dark"] .DocSearch-Button .DocSearch-Search-Icon {
     box-shadow: none !important;
 }
 
+.navbar {
+    height: auto;
+}
+
 .navbar, .main-wrapper {
     justify-content: center;
 }

package/src/theme.js

@@ -0,0 +1,43 @@
+function theme(
+    context,
+    options,
+) {
+    return {
+        name: '@apify/docs-theme',
+        getThemePath() {
+            return '../src/theme';
+        },
+        getTypeScriptThemePath() {
+            return '../src/theme';
+        },
+        contentLoaded({ actions }) {
+            const { setGlobalData } = actions;
+            setGlobalData({
+                options,
+            });
+        },
+        getClientModules() {
+            return [
+                require.resolve('./theme/custom.css'),
+            ];
+        },
+        configureWebpack() {
+            return {
+                module: {
+                    rules: [
+                        {
+                            test: /(@apify\/|apify-)docs-theme\/src\/theme\/.*?\.jsx?$/,
+                            use: {
+                                loader: 'babel-loader',
+                            },
+                        },
+                    ],
+                },
+            };
+        },
+    };
+}
+
+module.exports = {
+    theme,
+};

package/types/index.js

@@ -0,0 +1,12 @@
+/**
+ * @typedef {{
+ *      subNavbar: {
+ *          title: string,
+ *          items: any[]
+ *      }
+ * }} ThemeOptions
+*/
+
+module.exports = {
+    types: {},
+};