gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-21 07:38:53 +02:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity

feat(docs): use readme as index.md in mkdocs deployment

Browse Source
This commit is contained in:
perf3ct 2025-09-05 19:40:59 +00:00
parent d583ee2de3
commit c4d430c62d
No known key found for this signature in database
GPG Key ID: 569C4EEC436F5232
1 changed files with 57 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
scripts/fix-mkdocs-structure.ts
View File

@ -1,7 +1,8 @@
#!/usr/bin/env node #!/usr/bin/env node
/** /**
* Fix MkDocs structure by moving overview pages to index.md inside their directories. * Fix MkDocs structure by:
* This prevents duplicate navigation entries when a file and directory have the same name. * 1. Syncing README.md to docs/index.md with necessary path adjustments
* 2. Moving overview pages to index.md inside their directories to prevent duplicate navigation entries
*/ */
import * as fs from 'fs'; import * as fs from 'fs';
@ -235,6 +236,46 @@ function updateReferences(docsDir: string): FixResult[] {
return updatesMade; return updatesMade;
} }
/**
* Sync README.md to docs/index.md with necessary path adjustments
*/
function syncReadmeToIndex(projectRoot: string, docsDir: string): FixResult[] {
const results: FixResult[] = [];
const readmePath = path.join(projectRoot, 'README.md');
const indexPath = path.join(docsDir, 'index.md');
if (!fs.existsSync(readmePath)) {
console.warn('README.md not found in project root');
return results;
}
// Read README content
let content = fs.readFileSync(readmePath, 'utf-8');
// Fix image path (./docs/app.png -> app.png)
content = content.replace(/src="\.\/docs\/app\.png"/g, 'src="app.png"');
// Fix language links in header
content = content.replace(/\[English\]\(\.\/README\.md\)/g, '[English](./index.md)');
content = content.replace(/\.\/docs\/README-ZH_CN\.md/g, './README-ZH_CN.md');
content = content.replace(/\.\/docs\/README-ZH_TW\.md/g, './README-ZH_TW.md');
content = content.replace(/\.\/docs\/README\.ru\.md/g, './README.ru.md');
content = content.replace(/\.\/docs\/README\.ja\.md/g, './README.ja.md');
content = content.replace(/\.\/docs\/README\.it\.md/g, './README.it.md');
content = content.replace(/\.\/docs\/README\.es\.md/g, './README.es.md');
// Fix internal documentation links (./docs/User%20Guide -> ./User%20Guide)
content = content.replace(/\.\/docs\/User%20Guide/g, './User%20Guide');
// Write the adjusted content to docs/index.md
fs.writeFileSync(indexPath, content, 'utf-8');
results.push({
message: `Synced README.md to docs/index.md with path adjustments`
});
return results;
}
function main(): number { function main(): number {
// Get the docs directory // Get the docs directory
const scriptDir = path.dirname(new URL(import.meta.url).pathname); const scriptDir = path.dirname(new URL(import.meta.url).pathname);
@ -242,6 +283,9 @@ function main(): number {
const docsDir = path.join(projectRoot, 'docs'); const docsDir = path.join(projectRoot, 'docs');
// Handle Windows paths (remove leading slash if on Windows) // Handle Windows paths (remove leading slash if on Windows)
const normalizedProjectRoot = process.platform === 'win32' && projectRoot.startsWith('/')
? projectRoot.substring(1)
: projectRoot;
const normalizedDocsDir = process.platform === 'win32' && docsDir.startsWith('/') const normalizedDocsDir = process.platform === 'win32' && docsDir.startsWith('/')
? docsDir.substring(1) ? docsDir.substring(1)
: docsDir; : docsDir;
@ -254,6 +298,16 @@ function main(): number {
console.log(`Fixing MkDocs structure in ${normalizedDocsDir}`); console.log(`Fixing MkDocs structure in ${normalizedDocsDir}`);
console.log('-'.repeat(50)); console.log('-'.repeat(50));
// Sync README.md to docs/index.md
const syncResults = syncReadmeToIndex(normalizedProjectRoot, normalizedDocsDir);
if (syncResults.length > 0) {
console.log('README sync:');
for (const result of syncResults) {
console.log(` - ${result.message}`);
}
console.log();
}
// Fix duplicate entries // Fix duplicate entries
const fixes = fixDuplicateEntries(normalizedDocsDir); const fixes = fixDuplicateEntries(normalizedDocsDir);
if (fixes.length > 0) { if (fixes.length > 0) {
@ -279,7 +333,7 @@ function main(): number {
} }
console.log('-'.repeat(50)); console.log('-'.repeat(50));
console.log(`Structure fix complete: ${fixes.length} files moved, ${updates.length} files updated`); console.log(`Structure fix complete: ${syncResults.length} README syncs, ${fixes.length} files moved, ${updates.length} files updated`);
return 0; return 0;
} }