From 23aed7b208e70121b4b09315e22dcd259975ff57 Mon Sep 17 00:00:00 2001 From: Ryan-Millard Date: Thu, 2 Jul 2026 17:54:04 +0200 Subject: [PATCH 01/14] chore(website): move docusaurus site to root and make react example tertiary --- docs/.gitignore | 4 ++++ docs/blog/2025-12-05-launch.md | 2 +- docs/docs/index.md | 12 ++++++------ .../example-apps/react-js/components/NavBar/index.md | 2 +- docs/docs/js/index.md | 2 +- docs/docusaurus.config.js | 4 ++-- docs/scripts/help.js | 2 +- docs/src/pages/index.jsx | 2 +- docs/static/example-apps/react-js/.gitkeep | 4 ++++ example-apps/react-js/index.html | 4 ++-- example-apps/react-js/public/404.html | 12 ------------ example-apps/react-js/public/robots.txt | 5 ----- example-apps/react-js/scripts/help.js | 4 +--- example-apps/react-js/src/components/NavBar.jsx | 4 ++-- example-apps/react-js/src/components/NavBar.test.jsx | 6 +++--- example-apps/react-js/src/main.jsx | 2 +- .../react-js/src/pages/About/AboutHelmet.jsx | 4 ++-- .../react-js/src/pages/Credits/CreditsHelmet.jsx | 4 ++-- .../src/pages/Credits/DependencyCreditsCard.jsx | 2 +- .../react-js/src/pages/Editor/EditorHelmet.jsx | 2 +- .../react-js/src/pages/Editor/EditorHelmet.test.jsx | 3 --- example-apps/react-js/src/pages/Home/HomeHelmet.jsx | 4 ++-- example-apps/react-js/vite.config.js | 3 ++- 23 files changed, 40 insertions(+), 53 deletions(-) create mode 100644 docs/static/example-apps/react-js/.gitkeep delete mode 100644 example-apps/react-js/public/404.html delete mode 100644 example-apps/react-js/public/robots.txt diff --git a/docs/.gitignore b/docs/.gitignore index eba7249c8..ccf2cfbca 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,11 +1,15 @@ # Dependencies node_modules + +# Static files /static/docs/internal/**/api/* !/static/docs/internal/**/api/.gitkeep /static/docs/cpp/api/* !/static/docs/cpp/api/.gitkeep /static/docs/c/api/* !/static/docs/c/api/.gitkeep +/static/example-apps/react-js/* +!/static/example-apps/react-js/.gitkeep # Production /build diff --git a/docs/blog/2025-12-05-launch.md b/docs/blog/2025-12-05-launch.md index 6f51bd0b3..0e835dcca 100644 --- a/docs/blog/2025-12-05-launch.md +++ b/docs/blog/2025-12-05-launch.md @@ -16,6 +16,6 @@ Instead, it is now a library that supports C, C++, Python, and JavaScript. {/* truncate */} -Try it out online at [https://ryan-millard.github.io/Img2Num/](https://ryan-millard.github.io/Img2Num/) and start coloring your favorite images today! +Try it out online at [https://ryan-millard.github.io/Img2Num/example-apps/react-js/](https://ryan-millard.github.io/Img2Num/example-apps/react-js/) and start coloring your favorite images today! Stay tuned for tutorials, tips, and updates right here on the blog. diff --git a/docs/docs/index.md b/docs/docs/index.md index 16f6d197b..b73bd74cd 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -8,8 +8,8 @@ sidebar_position: 1 Img2Num is a lightweight, high-performance library for converting raster images to SVGs with ease and speed. -[![Docs](https://img.shields.io/badge/docs-full-blue?logo=gitbook&logoColor=white)](https://ryan-millard.github.io/Img2Num/info/docs/next/) -[![Changelog](https://img.shields.io/badge/changelog-full-orange?logo=git&logoColor=white)](https://ryan-millard.github.io/Img2Num/info/changelog/) +[![Docs](https://img.shields.io/badge/docs-full-blue?logo=gitbook&logoColor=white)](https://ryan-millard.github.io/Img2Num/docs/next/) +[![Changelog](https://img.shields.io/badge/changelog-full-orange?logo=git&logoColor=white)](https://ryan-millard.github.io/Img2Num/changelog/) ## Quick Overview @@ -27,10 +27,10 @@ Img2Num is a lightweight, high-performance library for converting raster images | Language | Status | Docs | Changelog | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/core) | [JS API Reference](./js) | [![C Changelog](https://img.shields.io/badge/changelog-C-A8B9CC?logo=c)](https://ryan-millard.github.io/Img2Num/info/changelog/c/) | -| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/bindings/c) | [C++ API Reference](./cpp) | [![C++ Changelog](https://img.shields.io/badge/changelog-C%2B%2B-00599C?logo=c%2B%2B&logoColor=white)](https://ryan-millard.github.io/Img2Num/info/changelog/cpp/) | -| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/packages/js) | [C API Reference](./c) | [![JavaScript Changelog](https://img.shields.io/badge/changelog-JavaScript-F7DF1E?logo=javascript)](https://ryan-millard.github.io/Img2Num/info/changelog/js/) | -| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/packages/js) | [Python API Reference](./py) | [![Python Changelog](https://img.shields.io/badge/changelog-Python-3776AB?logo=python)](https://ryan-millard.github.io/Img2Num/info/changelog/py/) | +| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/core) | [JS API Reference](./js) | [![C Changelog](https://img.shields.io/badge/changelog-C-A8B9CC?logo=c)](https://ryan-millard.github.io/Img2Num/changelog/c/) | +| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/bindings/c) | [C++ API Reference](./cpp) | [![C++ Changelog](https://img.shields.io/badge/changelog-C%2B%2B-00599C?logo=c%2B%2B&logoColor=white)](https://ryan-millard.github.io/Img2Num/changelog/cpp/) | +| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/packages/js) | [C API Reference](./c) | [![JavaScript Changelog](https://img.shields.io/badge/changelog-JavaScript-F7DF1E?logo=javascript)](https://ryan-millard.github.io/Img2Num/changelog/js/) | +| | [![Status](https://img.shields.io/badge/status-active_development-orange?logo=github)](https://github.com/Ryan-Millard/Img2Num/tree/main/packages/js) | [Python API Reference](./py) | [![Python Changelog](https://img.shields.io/badge/changelog-Python-3776AB?logo=python)](https://ryan-millard.github.io/Img2Num/changelog/py/) | --- diff --git a/docs/docs/internal/example-apps/react-js/components/NavBar/index.md b/docs/docs/internal/example-apps/react-js/components/NavBar/index.md index 97f3e1c80..9d4a21a0d 100644 --- a/docs/docs/internal/example-apps/react-js/components/NavBar/index.md +++ b/docs/docs/internal/example-apps/react-js/components/NavBar/index.md @@ -208,7 +208,7 @@ const INTERNAL_LINKS = [ ]; const EXTERNAL_LINKS = [ - { href: "https://ryan-millard.github.io/Img2Num/info/", label: "Docs", icon: Info, tooltip: "View documentation" }, + { href: "https://ryan-millard.github.io/Img2Num/", label: "Docs", icon: Info, tooltip: "View documentation" }, { href: "https://github.com/Ryan-Millard/Img2Num", label: "GitHub", diff --git a/docs/docs/js/index.md b/docs/docs/js/index.md index 6b5988279..a3ef34acd 100644 --- a/docs/docs/js/index.md +++ b/docs/docs/js/index.md @@ -180,7 +180,7 @@ writeFileSync("output.svg", svg); - [Documentation](/docs/js/docs/) - [GitHub repository](https://github.com/Ryan-Millard/Img2Num) -- [React demo app](https://ryan-millard.github.io/Img2Num/) +- [React demo app](https://ryan-millard.github.io/Img2Num/example-apps/react-js/) ## License diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 8e421d7f5..ce3d3b158 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -52,7 +52,7 @@ const config = { url: "https://ryan-millard.github.io/", // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' - baseUrl: "/Img2Num/info/", + baseUrl: "/Img2Num/", // GitHub Pages fix: canonical URL with trailing slash trailingSlash: true, @@ -184,7 +184,7 @@ const config = { announcementBar: { id: "docs-refactor-notice", - content: `⚠️ Some documentation pages are incomplete due to a recent refactor. Learn more.`, + content: `⚠️ Some documentation pages are incomplete due to a recent refactor. Learn more.`, backgroundColor: "#fdfd96", // light background textColor: "#091E42", // dark text isCloseable: true, diff --git a/docs/scripts/help.js b/docs/scripts/help.js index e008583a2..bad703895 100644 --- a/docs/scripts/help.js +++ b/docs/scripts/help.js @@ -1,7 +1,7 @@ import { runFuzzyCli, readPackageJsonScripts } from "img2num-dev-scripts"; const title = `Img2Num Docs CLI Scripts -Also see: https://ryan-millard.github.io/Img2Num/info/docs/category/-project-scripts +Also see: https://ryan-millard.github.io/Img2Num/docs/category/-project-scripts `; try { diff --git a/docs/src/pages/index.jsx b/docs/src/pages/index.jsx index 144764e28..d6b463b5f 100644 --- a/docs/src/pages/index.jsx +++ b/docs/src/pages/index.jsx @@ -109,7 +109,7 @@ function HeroSection() {
- + Try Live Demo →
diff --git a/docs/static/example-apps/react-js/.gitkeep b/docs/static/example-apps/react-js/.gitkeep new file mode 100644 index 000000000..db071a4ac --- /dev/null +++ b/docs/static/example-apps/react-js/.gitkeep @@ -0,0 +1,4 @@ +This folder is the output derived from building the react example app. + +See here: +- https://ryan-millard.github.io/Img2Num/example-apps/react-js/ diff --git a/example-apps/react-js/index.html b/example-apps/react-js/index.html index 854c047f8..fdb1a999d 100644 --- a/example-apps/react-js/index.html +++ b/example-apps/react-js/index.html @@ -32,10 +32,10 @@ - + - +