misc: add some comment

mildronize · May 23, 2024 · 362a874 · 362a874
1 parent 4eaef3d
commit 362a874
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/.vitepress/shared.ts b/docs/.vitepress/shared.ts
@@ -25,6 +25,12 @@ export const shared = defineConfig({
   head: [...googleFonts(), ...googleAnalytics("G-LWNNLXVF0K")],
 });
 
+/**
+ * Add Google Analytics 
+ * @ref https://vitepress.dev/reference/site-config#example-using-google-analytics
+ * @param tagManagerId 
+ * @returns 
+ */
 function googleAnalytics(tagManagerId: string): HeadConfig[] {
   return [
     ["script", { async: "", src: `https://www.googletagmanager.com/gtag/js?id=${tagManagerId}` }],

diff --git a/utils/utils.ts b/utils/utils.ts
@@ -1,3 +1,5 @@
+// TODO: Migrate to open source npm library: https://github.com/thaitype/vitepress-type-safe-i18n-navbar
+
 import type { DefaultTheme } from "vitepress";
 
 export type BaseSidebar = Omit<DefaultTheme.SidebarItem, "items" | "base"> & {