From 05d4861dbbafaa6972cf9498f2e01f7a8dc8478c Mon Sep 17 00:00:00 2001 From: StarFleetCPTN Date: Sat, 12 Apr 2025 13:43:28 -0700 Subject: [PATCH] chore: Enhance Docusaurus configuration and update image paths - Added explicit configuration for static directories in Docusaurus. - Updated npm script to ensure multiple screenshot paths are created and populated. - Adjusted image paths in documentation to use relative links for better compatibility. --- docs/docs/getting-started/quick-start.md | 4 ++-- docs/docusaurus.config.ts | 3 +++ docs/package.json | 2 +- docs/src/pages/index.tsx | 10 +++++----- 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/docs/getting-started/quick-start.md b/docs/docs/getting-started/quick-start.md index 41f154d..a08266f 100644 --- a/docs/docs/getting-started/quick-start.md +++ b/docs/docs/getting-started/quick-start.md @@ -23,7 +23,7 @@ The dashboard provides an overview of: - System status - Quick action buttons -![GoMFT Dashboard](/img/dashboard.gomft.png) +![GoMFT Dashboard](../../img/dashboard.gomft.png) ## Creating Your First Transfer Configuration @@ -36,7 +36,7 @@ The dashboard provides an overview of: - Configure transfer options (file filtering, bandwidth limits, etc.) 4. Click **Save Transfer** -![Create Transfer](/img/transfer.config.gomft.png) +![Create Transfer](../../img/transfer.config.gomft.png) ## Create Your First Scheduled Job 1. Naviagate to **Scheduled Jobs** in the sidebar menu diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 9a2ceee..c698867 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -22,6 +22,9 @@ const config: Config = { deploymentBranch: 'gh-pages', trailingSlash: false, + // Explicit static directories configuration + staticDirectories: ['static', 'static/screenshots'], + onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', diff --git a/docs/package.json b/docs/package.json index c9ff8e8..d4129d5 100644 --- a/docs/package.json +++ b/docs/package.json @@ -14,7 +14,7 @@ "write-heading-ids": "docusaurus write-heading-ids", "typecheck": "tsc", "deploy-gh-pages": "GIT_USER=StarFleetCPTN USE_SSH=true yarn deploy", - "prepare-screenshots": "node -e \"const fs = require('fs'); if (!fs.existsSync('./static/screenshots')) { fs.mkdirSync('./static/screenshots', { recursive: true }); fs.readdirSync('../screenshots').forEach(file => { if (!fs.existsSync('./static/screenshots/' + file)) { fs.copyFileSync('../screenshots/' + file, './static/screenshots/' + file); } }); }\"" + "prepare-screenshots": "node -e \"const fs = require('fs'); const paths = ['./static/screenshots', './static/img/screenshots']; paths.forEach(path => { if (!fs.existsSync(path)) { fs.mkdirSync(path, { recursive: true }); } }); fs.readdirSync('../screenshots').forEach(file => { paths.forEach(path => { const targetFile = path + '/' + file; if (!fs.existsSync(targetFile)) { fs.copyFileSync('../screenshots/' + file, targetFile); } }); });\"" }, "dependencies": { "@docusaurus/core": "3.7.0", diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index c5c01c1..9194456 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -15,9 +15,9 @@ function HomepageHeader() {
GoMFT Logo {siteConfig.title} @@ -125,7 +125,7 @@ export default function Home(): React.ReactNode {
- GoMFT Dashboard + GoMFT Dashboard
@@ -135,7 +135,7 @@ export default function Home(): React.ReactNode {
- Transfer Configuration + Transfer Configuration
Easy Deployment