@apify/docs-theme 1.0.38 → 1.0.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apify/docs-theme",
-  "version": "1.0.38",
+  "version": "1.0.40",
   "description": "",
   "main": "./src/index.js",
   "files": [
@@ -17,6 +17,7 @@
   "license": "ISC",
   "dependencies": {
     "@docusaurus/theme-common": "^2.2.0",
+    "axios": "^1.3.1",
     "babel-loader": "^9.1.0",
     "prism-react-renderer": "^1.3.5"
   }

package/src/theme/custom.css

@@ -667,7 +667,16 @@ aside li.section-header > div > .menu__link {
     opacity: 0.8;
     font-size: 1em;
     font-weight: 700;
-    margin: 5px 0;
+    margin: 0;
+}
+
+aside li.section-header.menu__list-item {
+    margin-top: 15px;
+    margin-bottom: 5px;
+}
+
+aside li.section-header.menu__list-item:nth-child(2) {
+    margin-top: 5px;
 }
 
 aside li.section-header > .menu__list {

package/src/theme.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const fs = require('fs');
+const axios = require('axios');
 
 function findPathInParent(endPath) {
     let parentPath = __dirname;
@@ -29,6 +30,36 @@ ${changelog.replaceAll(/\n#[^#]/g, '\n## ')}`;
     fs.writeFileSync(changelogPath, updated, 'utf-8');
 }
 
+async function copyChangelogFromReleases(paths, repo) {
+    const response = await axios.get(`https://api.github.com/repos/${repo}/releases`);
+    const releases = response.data;
+
+    let markdown = '';
+    releases.forEach((release, i, a) => {
+        markdown += release.tag_name && a[i + 1]?.tag_name
+            ? `## [${release.name}](https://github.com/${repo}/compare/${a[i + 1].tag_name}...${release.tag_name})\n`
+            : `## ${release.name}\n`;
+        markdown += `${release.body.replaceAll(/(^#|\n#)/g, '##')}\n`;
+    });
+
+    paths.forEach((p) => {
+        fs.writeFile(`${p}/changelog.md`, markdown, (err) => {
+            if (err) throw err;
+        });
+    });
+}
+
+function copyChangelogFromRoot(paths) {
+    const changelogPath = findPathInParentOrThrow('CHANGELOG.md');
+
+    for (const docsPath of paths) {
+        if (fs.existsSync(path.join(docsPath, 'changelog.md')) && fs.statSync(
+            path.join(docsPath, 'changelog.md')).mtime >= fs.statSync(changelogPath).mtime) continue;
+        fs.copyFileSync(changelogPath, path.join(docsPath, 'changelog.md'));
+        updateChangelog(path.join(docsPath, 'changelog.md'));
+    }
+}
+
 function theme(
     context,
     options,
@@ -46,9 +77,7 @@ function theme(
         },
         async loadContent() {
             try {
-                const changelogPath = findPathInParentOrThrow('CHANGELOG.md');
                 const versioned = findPathInParent('website/versioned_docs');
-
                 const pathsToCopyChangelog = [
                     findPathInParentOrThrow('docs'),
                     ...(versioned
@@ -57,12 +86,10 @@ function theme(
                     ),
                 ];
 
-                for (const docsPath of pathsToCopyChangelog) {
-                    if (fs.existsSync(path.join(docsPath, 'changelog.md')) && fs.statSync(
-                        path.join(docsPath, 'changelog.md')).mtime >= fs.statSync(changelogPath).mtime) continue;
-                    fs.copyFileSync(changelogPath, path.join(docsPath, 'changelog.md'));
-                    console.log(`copied ${changelogPath} to ${path.join(docsPath, 'changelog.md')}`);
-                    updateChangelog(path.join(docsPath, 'changelog.md'));
+                if (options.changelogFromRoot) {
+                    copyChangelogFromRoot(pathsToCopyChangelog);
+                } else {
+                    await copyChangelogFromReleases(pathsToCopyChangelog, `${context.siteConfig.organizationName}/${context.siteConfig.projectName}`);
                 }
             } catch (e) {
                 console.warn(`Changelog page could not be initialized: ${e.message}`);