/** * Generate and validate sitemap with hreflang tags for multilingual docs * https://developers.google.com/search/docs/specialty/international/localized-versions * * Only updates lastmod dates when actual page changes are detected */ const fs = require('fs'); const path = require('path'); const { execSync } = require('child_process'); const BASE_URL = 'https://www.helius.dev/docs'; const DEFAULT_LANGUAGE = 'en'; const LANGUAGES = { en: { code: 'en', name: 'English', urlPrefix: '', isDefault: true }, zh: { code: 'zh', name: '中文', urlPrefix: '/zh', isDefault: false } }; function getFileLastModified(filePath) { try { // Get last commit date for the file from git const date = execSync(`git log -1 --format=%cs -- "${filePath}"`, { cwd: path.join(__dirname, '..'), encoding: 'utf8' }).trim(); return date || new Date().toISOString().split('T')[0]; } catch (error) { // File not in git yet or git not available, use current date return new Date().toISOString().split('T')[0]; } } function getLocUrl(page, langConfig) { let pagePath; if (page === "index" || page === `${langConfig.code}/index`) { pagePath = ""; } else { pagePath = `/${page}`; } return `${BASE_URL}${langConfig.urlPrefix}${pagePath}`; } function findLlmsTxtFiles(docsRoot) { const llmsFiles = []; function walkDir(dir, relativePath = '') { const entries = fs.readdirSync(dir, { withFileTypes: true }); for (const entry of entries) { const fullPath = path.join(dir, entry.name); const relPath = relativePath ? `${relativePath}/${entry.name}` : entry.name; if (entry.isDirectory()) { // Skip zh directory (translations), node_modules, .git, etc. if (!['zh', 'node_modules', '.git', 'scripts'].includes(entry.name)) { walkDir(fullPath, relPath); } } else if (entry.name === 'llms.txt') { // Build URL path from directory path + filename llmsFiles.push({ filePath: fullPath, urlPath: relativePath ? `${relativePath}/llms.txt` : 'llms.txt' }); } } } walkDir(docsRoot); return llmsFiles; } function extractPagesFromNavigation(navigation, language = 'en') { const pages = []; function traverseGroups(groups) { for (const group of groups) { if (group.pages) { for (const page of group.pages) { if (typeof page === 'string') { pages.push(page); } else if (typeof page === 'object' && page.group && page.pages) { traverseGroups([page]); } } } if (group.groups) { traverseGroups(group.groups); } } } if (navigation.languages) { const langNav = navigation.languages.find(lang => lang.language === language); if (langNav && langNav.anchors) { for (const anchor of langNav.anchors) { if (anchor.groups) { traverseGroups(anchor.groups); } } } } return pages; } function generateSitemap() { try { const docsRoot = path.join(__dirname, '..'); const docsPath = path.join(docsRoot, 'docs.json'); const docs = JSON.parse(fs.readFileSync(docsPath, 'utf8')); const allLanguages = {}; for (const langCode of Object.keys(LANGUAGES)) { const pages = extractPagesFromNavigation(docs.navigation, langCode); allLanguages[langCode] = pages.map(p => p.replace(/^(en|zh)\//, '')); } const uniquePages = new Set(); for (const pages of Object.values(allLanguages)) { pages.forEach(page => uniquePages.add(page)); } let sitemap = '\n'; sitemap += '${url}\n`; sitemap += ` ${lastmod}\n`; sitemap += ' \n'; } // Generate a entry for each language version of each page for (const page of Array.from(uniquePages).sort()) { for (const [langCode, langConfig] of Object.entries(LANGUAGES)) { // Only generate URL entry if this language has this page if (!allLanguages[langCode].includes(page)) continue; const locUrl = getLocUrl(page, langConfig); // Get last modified date from git for this language's file const mdxPath = langConfig.urlPrefix ? path.join(docsRoot, langConfig.urlPrefix.substring(1), `${page}.mdx`) : path.join(docsRoot, `${page}.mdx`); const lastmod = getFileLastModified(mdxPath); sitemap += ' \n'; sitemap += ` ${locUrl}\n`; sitemap += ` ${lastmod}\n`; // Add alternate links for all available language versions for (const [altLangCode, altLangConfig] of Object.entries(LANGUAGES)) { if (allLanguages[altLangCode].includes(page)) { const hrefUrl = getLocUrl(page, altLangConfig); sitemap += ` \n`; } } // x-default always points to English version const defaultUrl = getLocUrl(page, LANGUAGES.en); sitemap += ` \n`; sitemap += ' \n'; } } sitemap += '\n'; const outputPath = path.join(docsRoot, 'sitemap.xml'); const oldSitemap = fs.existsSync(outputPath) ? fs.readFileSync(outputPath, 'utf8') : ''; // Write new sitemap fs.writeFileSync(outputPath, sitemap, 'utf8'); // Check if anything actually changed (ignoring just date changes on unchanged files) const changed = oldSitemap !== sitemap; // Count total URL entries across all languages let totalUrlEntries = 0; for (const [langCode] of Object.entries(LANGUAGES)) { totalUrlEntries += allLanguages[langCode].length; } console.log(`✓ Sitemap generated: ${uniquePages.size} unique pages`); console.log(`✓ URL entries: ${totalUrlEntries} (across ${Object.keys(LANGUAGES).length} languages)`); console.log(`✓ llms.txt files: ${llmsFiles.length}`); console.log(`✓ Languages: ${Object.keys(LANGUAGES).join(', ')}`); console.log(`✓ Changed: ${changed ? 'Yes' : 'No (dates preserved)'}`); // Quick validation const urlCount = (sitemap.match(//g) || []).length; const expectedUrlCount = totalUrlEntries + llmsFiles.length; if (urlCount === expectedUrlCount) { console.log('✓ Validation passed'); return true; } else { console.error(`❌ Validation failed: expected ${expectedUrlCount} URLs, got ${urlCount}`); return false; } } catch (error) { console.error('❌ Error:', error.message); return false; } } if (require.main === module) { const success = generateSitemap(); process.exit(success ? 0 : 1); } module.exports = { generateSitemap };

API 参考

Solana RPC APIs

Solana APIs

数据流 API

事件监听 API

弃用 API

Page Not Found