add changelog

Author: DerGoogler

docs/.vitepress/config/en.ts

@@ -2,6 +2,7 @@ import { createRequire } from "module";
 import { defineConfig } from "vitepress";
 import request from "sync-request";
 import { repositories } from "../../data/repositories";
+import { changelog } from "../../data/changelog";
 
 const require = createRequire(import.meta.url);
 const pkg = require("vitepress/package.json");
@@ -18,6 +19,7 @@ export default defineConfig({
     sidebar: {
       "/guide/": sidebarGuide(),
       "/repository/": sidebarRepositories(),
+      "/changelog/": sidebarChangelog(),
       "/legal/": sidebarLegal(),
     },
 
@@ -35,8 +37,7 @@ export default defineConfig({
     },
 
     editLink: {
-      pattern:
-        "https://github.com/MMRLApp/MMRLApp.github.io/edit/master/docs/:path",
+      pattern: "https://github.com/MMRLApp/MMRLApp.github.io/edit/master/docs/:path",
       text: "Edit this page on GitHub",
     },
   },
@@ -47,6 +48,7 @@ function nav() {
     { text: "Guide", link: "/guide" },
     { text: "Repositories", link: "/repository" },
     { text: "Blacklist", link: "/blacklist" },
+    { text: "Changelog", link: `/changelog/${changelog[0].versionCode}` },
     { text: "Legal", link: "/legal/privacy" },
   ];
 }
@@ -139,3 +141,31 @@ function sidebarRepositories() {
     },
   ];
 }
+
+function sidebarChangelog() {
+  return [
+    {
+      text: "Changelog",
+      items: changelog.map((log) => {
+        const spanCss = `
+          border-color: var(--vp-badge-warning-border);
+          color: var(--vp-badge-warning-text);
+          background-color: var(--vp-badge-warning-bg);
+          display: inline-block;
+          border: 1px solid transparent;
+          border-radius: 12px;
+          padding: 0 10px;
+          line-height: 22px;
+          font-size: 12px;
+          font-weight: 500;
+          transform: translateY(-2px);
+        `;
+
+        return {
+          text: `${log.versionName} (${log.versionCode}) ${log.preRelease ? `<span style="${spanCss}">PR</span>` : ""}`,
+          link: `/changelog/${log.versionCode}`,
+        };
+      }),
+    },
+  ];
+}

docs/.vitepress/config/shared.ts

@@ -7,6 +7,7 @@ import { writeFile } from "fs/promises";
 import { resolve } from "path";
 import { repositoriesJSONstringify } from "../../data/repositories";
 import { blacklistJSONstringify } from "../../data/blacklist";
+import { changelogJSONstringify } from "../../data/changelog";
 
 export const shared = defineConfig({
   vite: {
@@ -51,8 +52,10 @@ export const shared = defineConfig({
     const publicApi = resolve(config.outDir, "api");
     const publicRepoList = resolve(publicApi, "repositories.json");
     const publicBlackList = resolve(publicApi, "blacklist.json");
+    const publicChangelogList = resolve(publicApi, "changelog.json");
 
     await writeFile(publicRepoList, repositoriesJSONstringify);
     await writeFile(publicBlackList, blacklistJSONstringify);
+    await writeFile(publicChangelogList, changelogJSONstringify);
   },
 });

docs/data/blacklist.ts

@@ -2,7 +2,7 @@ import { readFileSync } from "fs";
 import { join } from "path";
 import { parse } from "yaml";
 
-export const fileName = join(__dirname, "blacklist.yaml");
+export const fileName = join(__dirname, "../../meta/blacklist.yaml");
 
 export const blacklist: any = parse(readFileSync(fileName, "utf8"));
 export const blacklistJSONstringify: string = JSON.stringify(

docs/data/changelog.ts

@@ -0,0 +1,12 @@
+import { readFileSync } from "fs";
+import { join } from "path";
+import { parse } from "yaml";
+
+export const fileName = join(__dirname, "../../meta/changelog.yaml");
+
+export const changelog: any = parse(readFileSync(fileName, "utf8"));
+export const changelogJSONstringify: string = JSON.stringify(
+  changelog,
+  null,
+  4
+);

docs/data/repositories.ts

@@ -2,7 +2,7 @@ import { readFileSync } from "fs";
 import { join } from "path";
 import { parse } from "yaml";
 
-export const fileName = join(__dirname, "repositories.yaml");
+export const fileName = join(__dirname, "../../meta/repositories.yaml");
 
 export const repositories: any = parse(readFileSync(fileName, "utf8"));
 export const repositoriesJSONstringify: string = JSON.stringify(

docs/en/changelog/[versionCode].md

@@ -0,0 +1,9 @@
+---
+editLink: false
+prev: false
+next: false
+---
+
+# {{ $params.title }} <Badge v-if="$params.preRelease" type="warning" text="PR" />
+
+<!-- @content -->

docs/en/changelog/[versionCode].paths.ts

@@ -0,0 +1,17 @@
+import { changelog } from "../../data/changelog";
+
+export default {
+  paths() {
+    return changelog.map((log) => {
+        return {
+          params: {
+            title: log.versionName + " (" + log.versionCode + ")",
+            versionName: log.versionName,
+            versionCode: log.versionCode,
+            preRelease: log.preRelease,
+          },
+          content: log.changes
+        };
+      });
+  },
+};