@x-wave/blog 2.3.1 → 2.3.2

package/consts/index.ts

@@ -0,0 +1,9 @@
+export const DOCS_TITLE = 'Staking Docs'
+
+export const SUPPORTED_LANGUAGES = ['en', 'zh', 'es'] as const
+
+export const GITHUB_REPO_URL = 'https://github.com/polkadot-cloud'
+
+export const STAKING_DASHBOARD_URL = 'https://staking.polkadot.cloud'
+
+export { NAVIGATION_DATA } from './navigation'

package/consts/navigation.ts

@@ -0,0 +1,26 @@
+import type { NavigationEntry } from 'types'
+
+// Navigation structure - defines the sidebar menu order and grouping
+// - Individual item titles are loaded from their MDX frontmatter
+// - Section titles are i18n keys (e.g., 'nav.helpResources') and will be translated
+// Optional properties:
+// - hasAdvanced: boolean - indicates if the page has an advanced version
+// - defaultOpen: boolean - for sections, set to true to have them open by default
+// Note: showTableOfContents is configured in each article's frontmatter, not here
+export const NAVIGATION_DATA: NavigationEntry[] = [
+	{
+		slug: 'welcome',
+	},
+	{
+		title: 'nav.helpResources',
+		defaultOpen: true,
+		items: [
+			{
+				slug: 'glossary',
+			},
+			{
+				slug: 'faq',
+			},
+		],
+	},
+]

package/locales/index.ts

@@ -0,0 +1,182 @@
+import i18n from 'i18next'
+import LanguageDetector from 'i18next-browser-languagedetector'
+import { initReactI18next } from 'react-i18next'
+
+const resources = {
+	en: {
+		translation: {
+			language: 'English',
+			languageCode: 'en',
+			nav: {
+				gettingStarted: 'Getting Started',
+				helpResources: 'Help Resources',
+				guides: 'Guides',
+				reference: 'Reference',
+				previous: 'Previous',
+				next: 'Next',
+			},
+			docs: {
+				helloWorld: 'Welcome!',
+				gettingStarted: 'Getting Started',
+				glossary: 'Glossary',
+				faq: 'FAQ',
+			},
+			ui: {
+				home: 'Home',
+				simple: 'Simple',
+				advanced: 'Advanced',
+				switchLanguage: 'Switch Language',
+				tableOfContents: 'Table of Contents',
+				onThisPage: 'On this page',
+				launchApp: 'Launch App',
+				support: 'Support',
+				discord: 'Discord',
+				email: 'Email',
+				theme: 'Theme',
+				light: 'Light',
+				dark: 'Dark',
+				system: 'System',
+				search: 'Search',
+				searchPlaceholder: 'Search documentation...',
+				searchNavigate: 'to navigate',
+				searchSelect: 'to select',
+				searchClose: 'to close',
+				noSearchResults: 'No results found',
+				tags: 'Tags',
+				filterByTag: 'Filter by tag',
+				tagResults: 'Articles tagged with',
+				noTagResults: 'No articles found with this tag',
+				lastEdited: 'Last edited',
+				axes: 'Articles',
+				latestPosts: 'Latest Posts',
+				loadingArticles: 'Loading articles...',
+				noArticlesFound: 'No articles found',
+				by: 'By',
+				connect: 'Connect',
+			},
+		},
+	},
+	zh: {
+		translation: {
+			language: '中文',
+			languageCode: 'zh',
+			nav: {
+				gettingStarted: '开始使用',
+				helpResources: '帮助资源',
+				guides: '指南',
+				reference: '参考',
+				previous: '上一篇',
+				next: '下一篇',
+			},
+			docs: {
+				helloWorld: '欢迎！',
+				gettingStarted: '开始使用',
+				glossary: '术语表',
+				faq: '常见问题',
+			},
+			ui: {
+				home: '首页',
+				simple: '简单',
+				advanced: '高级',
+				switchLanguage: '切换语言',
+				tableOfContents: '目录',
+				onThisPage: '本页内容',
+				launchApp: '启动应用',
+				support: '支持',
+				discord: 'Discord',
+				email: '电子邮件',
+				theme: '主题',
+				light: '浅色',
+				dark: '深色',
+				system: '系统',
+				search: '搜索',
+				searchPlaceholder: '搜索文档...',
+				searchNavigate: '导航',
+				searchSelect: '选择',
+				searchClose: '关闭',
+				noSearchResults: '未找到结果',
+				tags: '标签',
+				filterByTag: '按标签筛选',
+				tagResults: '带有标签的文章',
+				noTagResults: '未找到带有此标签的文章',
+				lastEdited: '最后编辑',
+				articles: '文章',
+				loadingArticles: '正在加载文章...',
+				noArticlesFound: '未找到文章',
+				by: '作者',
+				connect: '连接',
+			},
+		},
+	},
+	es: {
+		translation: {
+			language: 'Español',
+			languageCode: 'es',
+			nav: {
+				gettingStarted: 'Primeros Pasos',
+				helpResources: 'Recursos de Ayuda',
+				guides: 'Guías',
+				reference: 'Referencia',
+				previous: 'Anterior',
+				next: 'Siguiente',
+			},
+			docs: {
+				helloWorld: '¡Bienvenido!',
+				gettingStarted: 'Primeros Pasos',
+				glossary: 'Glosario',
+				faq: 'Preguntas Frecuentes',
+			},
+			ui: {
+				home: 'Inicio',
+				simple: 'Simple',
+				advanced: 'Avanzado',
+				switchLanguage: 'Cambiar Idioma',
+				tableOfContents: 'Tabla de Contenidos',
+				onThisPage: 'En esta página',
+				launchApp: 'Iniciar App',
+				support: 'Soporte',
+				discord: 'Discord',
+				email: 'Correo',
+				theme: 'Tema',
+				light: 'Claro',
+				dark: 'Oscuro',
+				system: 'Sistema',
+				search: 'Buscar',
+				searchPlaceholder: 'Buscar documentación...',
+				searchNavigate: 'para navegar',
+				searchSelect: 'para seleccionar',
+				searchClose: 'para cerrar',
+				noSearchResults: 'No se encontraron resultados',
+				tags: 'Etiquetas',
+				filterByTag: 'Filtrar por etiqueta',
+				tagResults: 'Artículos etiquetados con',
+				noTagResults: 'No se encontraron artículos con esta etiqueta',
+				lastEdited: 'Última edición',
+				articles: 'Artículos',
+				loadingArticles: 'Cargando artículos...',
+				noArticlesFound: 'No se encontraron artículos',
+				by: 'Por',
+				connect: 'Conectar',
+			},
+		},
+	},
+}
+
+i18n
+	.use(LanguageDetector)
+	.use(initReactI18next)
+	.init({
+		resources,
+		fallbackLng: 'en',
+		lng: 'en', // Set 'en' as the initial language synchronously
+		debug: false,
+		interpolation: {
+			escapeValue: false,
+		},
+		detection: {
+			order: ['path', 'localStorage', 'navigator'],
+			lookupFromPathIndex: 0,
+		},
+	})
+
+export default i18n

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x-wave/blog",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "type": "module",
   "exports": {
     ".": {

package/types/index.ts

@@ -0,0 +1,40 @@
+export interface NavigationItem {
+	slug: string
+	hasAdvanced?: boolean
+}
+
+export interface NavigationItemWithTitle extends NavigationItem {
+	title: string
+}
+
+export interface NavigationSection {
+	title: string
+	items: NavigationItem[]
+	defaultOpen?: boolean
+}
+
+export interface NavigationSectionWithTitles {
+	title: string
+	items: NavigationItemWithTitle[]
+	defaultOpen?: boolean
+}
+
+export type NavigationEntry = NavigationSection | NavigationItem
+
+export type NavigationEntryWithTitles =
+	| NavigationSectionWithTitles
+	| NavigationItemWithTitle
+
+export interface LoadedContent {
+	content: string
+	frontmatter: {
+		title?: string
+		hasAdvanced?: boolean
+		tags?: string[]
+		date?: string
+		author?: string
+		[key: string]: unknown
+	}
+}
+
+export type SupportedLanguage = string

package/consts/index.js

@@ -1,24 +0,0 @@
-const t = [
-  {
-    slug: "welcome"
-  },
-  {
-    title: "nav.helpResources",
-    defaultOpen: !0,
-    items: [
-      {
-        slug: "glossary"
-      },
-      {
-        slug: "faq"
-      }
-    ]
-  }
-], s = "Staking Docs", o = ["en", "zh", "es"], e = "https://github.com/polkadot-cloud", l = "https://staking.polkadot.cloud";
-export {
-  s as DOCS_TITLE,
-  e as GITHUB_REPO_URL,
-  t as NAVIGATION_DATA,
-  l as STAKING_DASHBOARD_URL,
-  o as SUPPORTED_LANGUAGES
-};

package/locales/index.js

@@ -1,180 +0,0 @@
-import e from "i18next";
-import { default as c } from "i18next";
-import a from "i18next-browser-languagedetector";
-import { initReactI18next as t } from "react-i18next";
-const s = {
-  en: {
-    translation: {
-      language: "English",
-      languageCode: "en",
-      nav: {
-        gettingStarted: "Getting Started",
-        helpResources: "Help Resources",
-        guides: "Guides",
-        reference: "Reference",
-        previous: "Previous",
-        next: "Next"
-      },
-      docs: {
-        helloWorld: "Welcome!",
-        gettingStarted: "Getting Started",
-        glossary: "Glossary",
-        faq: "FAQ"
-      },
-      ui: {
-        home: "Home",
-        simple: "Simple",
-        advanced: "Advanced",
-        switchLanguage: "Switch Language",
-        tableOfContents: "Table of Contents",
-        onThisPage: "On this page",
-        launchApp: "Launch App",
-        support: "Support",
-        discord: "Discord",
-        email: "Email",
-        theme: "Theme",
-        light: "Light",
-        dark: "Dark",
-        system: "System",
-        search: "Search",
-        searchPlaceholder: "Search documentation...",
-        searchNavigate: "to navigate",
-        searchSelect: "to select",
-        searchClose: "to close",
-        noSearchResults: "No results found",
-        tags: "Tags",
-        filterByTag: "Filter by tag",
-        tagResults: "Articles tagged with",
-        noTagResults: "No articles found with this tag",
-        lastEdited: "Last edited",
-        axes: "Articles",
-        latestPosts: "Latest Posts",
-        loadingArticles: "Loading articles...",
-        noArticlesFound: "No articles found",
-        by: "By",
-        connect: "Connect"
-      }
-    }
-  },
-  zh: {
-    translation: {
-      language: "中文",
-      languageCode: "zh",
-      nav: {
-        gettingStarted: "开始使用",
-        helpResources: "帮助资源",
-        guides: "指南",
-        reference: "参考",
-        previous: "上一篇",
-        next: "下一篇"
-      },
-      docs: {
-        helloWorld: "欢迎！",
-        gettingStarted: "开始使用",
-        glossary: "术语表",
-        faq: "常见问题"
-      },
-      ui: {
-        home: "首页",
-        simple: "简单",
-        advanced: "高级",
-        switchLanguage: "切换语言",
-        tableOfContents: "目录",
-        onThisPage: "本页内容",
-        launchApp: "启动应用",
-        support: "支持",
-        discord: "Discord",
-        email: "电子邮件",
-        theme: "主题",
-        light: "浅色",
-        dark: "深色",
-        system: "系统",
-        search: "搜索",
-        searchPlaceholder: "搜索文档...",
-        searchNavigate: "导航",
-        searchSelect: "选择",
-        searchClose: "关闭",
-        noSearchResults: "未找到结果",
-        tags: "标签",
-        filterByTag: "按标签筛选",
-        tagResults: "带有标签的文章",
-        noTagResults: "未找到带有此标签的文章",
-        lastEdited: "最后编辑",
-        articles: "文章",
-        loadingArticles: "正在加载文章...",
-        noArticlesFound: "未找到文章",
-        by: "作者",
-        connect: "连接"
-      }
-    }
-  },
-  es: {
-    translation: {
-      language: "Español",
-      languageCode: "es",
-      nav: {
-        gettingStarted: "Primeros Pasos",
-        helpResources: "Recursos de Ayuda",
-        guides: "Guías",
-        reference: "Referencia",
-        previous: "Anterior",
-        next: "Siguiente"
-      },
-      docs: {
-        helloWorld: "¡Bienvenido!",
-        gettingStarted: "Primeros Pasos",
-        glossary: "Glosario",
-        faq: "Preguntas Frecuentes"
-      },
-      ui: {
-        home: "Inicio",
-        simple: "Simple",
-        advanced: "Avanzado",
-        switchLanguage: "Cambiar Idioma",
-        tableOfContents: "Tabla de Contenidos",
-        onThisPage: "En esta página",
-        launchApp: "Iniciar App",
-        support: "Soporte",
-        discord: "Discord",
-        email: "Correo",
-        theme: "Tema",
-        light: "Claro",
-        dark: "Oscuro",
-        system: "Sistema",
-        search: "Buscar",
-        searchPlaceholder: "Buscar documentación...",
-        searchNavigate: "para navegar",
-        searchSelect: "para seleccionar",
-        searchClose: "para cerrar",
-        noSearchResults: "No se encontraron resultados",
-        tags: "Etiquetas",
-        filterByTag: "Filtrar por etiqueta",
-        tagResults: "Artículos etiquetados con",
-        noTagResults: "No se encontraron artículos con esta etiqueta",
-        lastEdited: "Última edición",
-        articles: "Artículos",
-        loadingArticles: "Cargando artículos...",
-        noArticlesFound: "No se encontraron artículos",
-        by: "Por",
-        connect: "Conectar"
-      }
-    }
-  }
-};
-e.use(a).use(t).init({
-  resources: s,
-  fallbackLng: "en",
-  lng: "en",
-  // Set 'en' as the initial language synchronously
-  debug: !1,
-  interpolation: {
-    escapeValue: !1
-  },
-  detection: {
-    order: ["path", "localStorage", "navigator"],
-    lookupFromPathIndex: 0
-  }
-});
-export {
-  c as default
-};

package/types/index.d.ts

@@ -1,31 +0,0 @@
-export interface NavigationItem {
-    slug: string;
-    hasAdvanced?: boolean;
-}
-export interface NavigationItemWithTitle extends NavigationItem {
-    title: string;
-}
-export interface NavigationSection {
-    title: string;
-    items: NavigationItem[];
-    defaultOpen?: boolean;
-}
-export interface NavigationSectionWithTitles {
-    title: string;
-    items: NavigationItemWithTitle[];
-    defaultOpen?: boolean;
-}
-export type NavigationEntry = NavigationSection | NavigationItem;
-export type NavigationEntryWithTitles = NavigationSectionWithTitles | NavigationItemWithTitle;
-export interface LoadedContent {
-    content: string;
-    frontmatter: {
-        title?: string;
-        hasAdvanced?: boolean;
-        tags?: string[];
-        date?: string;
-        author?: string;
-        [key: string]: unknown;
-    };
-}
-export type SupportedLanguage = string;