@apify/docs-theme 1.0.131 → 1.0.133

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@apify/docs-theme",
-    "version": "1.0.131",
+    "version": "1.0.133",
     "description": "",
     "main": "./src/index.js",
     "files": [

package/src/markdown.js

@@ -1,12 +1,13 @@
 function updateChangelog(changelog) {
-    changelog = addHeader(changelog);
+    changelog = addFrontmatter(changelog);
     changelog = pushHeadings(changelog);
-    changelog = linkUsers(changelog);
-    changelog = linkPRs(changelog);
+    changelog = fixUserLinks(changelog);
+    changelog = fixPRLinks(changelog);
+    changelog = escapeMDXCharacters(changelog);
     return changelog;
 }
 
-function addHeader(changelog, header = 'Changelog') {
+function addFrontmatter(changelog, header = 'Changelog') {
     return `---
 title: ${header}
 sidebar_label: ${header}
@@ -19,14 +20,22 @@ function pushHeadings(changelog) {
     return changelog.replaceAll(/\n#[^#]/g, '\n## ');
 }
 
-function linkUsers(changelog) {
+function fixUserLinks(changelog) {
     return changelog.replaceAll(/by @([a-zA-Z0-9-]+)/g, 'by [@$1](https://github.com/$1)');
 }
 
-function linkPRs(changelog) {
+function fixPRLinks(changelog) {
     return changelog.replaceAll(/(((https?:\/\/)?(www.)?)?github.com\/[^\s]*?\/pull\/([0-9]+))/g, '[#$5]($1)');
 }
 
+function escapeMDXCharacters(changelog) {
+    return changelog.replaceAll(/<|>/g, (match) => {
+        return match === '<' ? '&lt;' : '&gt;';
+    }).replaceAll(/\{|\}/g, (match) => {
+        return match === '{' ? '&#123;' : '&#125;';
+    });
+}
+
 module.exports = {
     updateChangelog,
 };

package/src/theme.js

@@ -25,7 +25,7 @@ function findPathInParentOrThrow(endPath) {
     return filePath;
 }
 
-async function copyChangelogFromReleases(paths, repo) {
+async function generateChangelogFromGitHubReleases(paths, repo) {
     const response = await axios.get(`https://api.github.com/repos/${repo}/releases`);
     const releases = response.data;
 
@@ -40,18 +40,24 @@ async function copyChangelogFromReleases(paths, repo) {
     });
 
     paths.forEach((p) => {
-        fs.writeFileSync(`${p}/changelog.md`, updateChangelog(markdown));
+        fs.writeFileSync(path.join(p, 'changelog.md'), updateChangelog(markdown));
     });
 }
 
-function copyChangelogFromRoot(paths) {
-    const changelogPath = findPathInParentOrThrow('CHANGELOG.md');
+function copyChangelogFromRoot(paths, hasDefaultChangelog) {
+    const sourceChangelogPath = 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;
-        const changelog = fs.readFileSync(changelogPath, 'utf-8');
-        fs.writeFileSync(`${docsPath}/changelog.md`, updateChangelog(changelog));
+        const targetChangelogPath = path.join(docsPath, 'changelog.md');
+
+        if (fs.existsSync(targetChangelogPath)
+            && fs.statSync(targetChangelogPath).mtime >= fs.statSync(sourceChangelogPath).mtime
+            && !hasDefaultChangelog.get(docsPath)) {
+            continue;
+        }
+
+        const changelog = fs.readFileSync(sourceChangelogPath, 'utf-8');
+        fs.writeFileSync(targetChangelogPath, updateChangelog(changelog));
     }
 }
 
@@ -81,6 +87,8 @@ function theme(
                     ),
                 ];
 
+                const hasDefaultChangelog = new Map();
+
                 for (const p of pathsToCopyChangelog) {
                     // the changelog page has to exist for the sidebar to work - async loadContent() is (apparently) not awaited for by sidebar
                     if (fs.existsSync(path.join(p, 'changelog.md'))) continue;
@@ -91,12 +99,13 @@ sidebar_label: Changelog
 It seems that the changelog is not available.
 This either means that your Docusaurus setup is misconfigured, or that your GitHub repository contains no releases yet.
 `);
+                    hasDefaultChangelog.set(p, true);
                 }
 
                 if (options.changelogFromRoot) {
-                    copyChangelogFromRoot(pathsToCopyChangelog);
+                    copyChangelogFromRoot(pathsToCopyChangelog, hasDefaultChangelog);
                 } else {
-                    await copyChangelogFromReleases(pathsToCopyChangelog, `${context.siteConfig.organizationName}/${context.siteConfig.projectName}`);
+                    await generateChangelogFromGitHubReleases(pathsToCopyChangelog, `${context.siteConfig.organizationName}/${context.siteConfig.projectName}`);
                 }
             } catch (e) {
                 // eslint-disable-next-line no-console

package/src/theme/MDXComponents/Pre.js

@@ -1,14 +0,0 @@
-import CodeBlock from '@theme/CodeBlock';
-import React, { isValidElement } from 'react';
-
-export default function MDXPre(props) {
-    return (
-        <CodeBlock
-            // If this pre is created by a ``` fenced codeblock, unwrap the children
-            {...(isValidElement(props.children)
-      && props.children.props?.originalType === 'code'
-                ? props.children.props
-                : { ...props })}
-        />
-    );
-}