From 2472dd9053d94a5ad5a8645156e117d131361882 Mon Sep 17 00:00:00 2001 From: "Alex J Hawk (HMS)" <51409174+alexjhawk@users.noreply.github.com> Date: Tue, 7 Nov 2023 15:38:57 -0500 Subject: [PATCH] Add common docs import --- web-docs/.gitignore | 3 +++ web-docs/docusaurus.config.js | 13 +++++++++++++ web-docs/package.json | 1 + web-docs/yarn.lock | 34 ++++++++++++++++++++++++++++++++++ 4 files changed, 51 insertions(+) diff --git a/web-docs/.gitignore b/web-docs/.gitignore index 50b2292..ecc6c15 100644 --- a/web-docs/.gitignore +++ b/web-docs/.gitignore @@ -18,3 +18,6 @@ build npm-debug.log* yarn-debug.log* yarn-error.log* + +# Auto-downloaded common docs +docs/_partial/common \ No newline at end of file diff --git a/web-docs/docusaurus.config.js b/web-docs/docusaurus.config.js index ed489fc..935c3df 100644 --- a/web-docs/docusaurus.config.js +++ b/web-docs/docusaurus.config.js @@ -32,6 +32,19 @@ const config = { locales: ['en'], }, + // Plugins + plugins: [ + [ + "docusaurus-plugin-remote-content", + { + name: "sc-common-docs", // used by CLI, must be path safe + sourceBaseUrl: "https://raw.githubusercontent.com/hms-networks/sc-ewon-flexy-common-docs/THK_DEV/docs/", // the base url for the markdown (gets prepended to all of the documents when fetching) + outDir: "docs/_partial/common", // the base directory to output to. + documents: ["_logging.mdx","_sys_req_ewon_fw.mdx","_sys_req_java.mdx","_sys_req_maven.mdx"], // the file names to download + }, + ], + ], + presets: [ [ 'classic', diff --git a/web-docs/package.json b/web-docs/package.json index 78ca2ce..8c60780 100644 --- a/web-docs/package.json +++ b/web-docs/package.json @@ -19,6 +19,7 @@ "@docusaurus/preset-classic": "^2.4.1", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1", + "docusaurus-plugin-remote-content": "^3.1.0", "prism-react-renderer": "^1.3.5", "raw-loader": "^4.0.2", "react": "^17.0.2", diff --git a/web-docs/yarn.lock b/web-docs/yarn.lock index 5b8bc65..f5305ca 100644 --- a/web-docs/yarn.lock +++ b/web-docs/yarn.lock @@ -2689,6 +2689,13 @@ axios@^0.25.0: dependencies: follow-redirects "^1.14.7" +axios@^0.26.1: + version "0.26.1" + resolved "https://registry.yarnpkg.com/axios/-/axios-0.26.1.tgz#1ede41c51fcf51bbbd6fd43669caaa4f0495aaa9" + integrity sha512-fPwcX4EvnSHuInCMItEhAGnaSEXRBjtzh9fOtsE6E1G6p7vl7edEeZe11QHf18+6+9gR5PbKV/sGKNaD8YaMeA== + dependencies: + follow-redirects "^1.14.8" + babel-loader@^8.2.5: version "8.3.0" resolved "https://registry.yarnpkg.com/babel-loader/-/babel-loader-8.3.0.tgz#124936e841ba4fe8176786d6ff28add1f134d6a8" @@ -3605,6 +3612,16 @@ dns-packet@^5.2.2: dependencies: "@leichtgewicht/ip-codec" "^2.0.1" +docusaurus-plugin-remote-content@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-remote-content/-/docusaurus-plugin-remote-content-3.1.0.tgz#d9349da5e098ba65050c5e00ef2425f3edb5e837" + integrity sha512-859WYmC75l9hRYa1f/2FNF+FLcKbkHCM/0dehN1Wl1fIuoFzEPf3tcWs4jcEobRHYnoMjyupqAhmu0q5j3JoIg== + dependencies: + axios "^0.26.1" + picocolors "^1.0.0" + pretty-ms "^7.0.1" + rimraf "^3.0.2" + dom-converter@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768" @@ -4068,6 +4085,11 @@ follow-redirects@^1.0.0, follow-redirects@^1.14.7: resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.2.tgz#b460864144ba63f2681096f274c4e57026da2c13" integrity sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA== +follow-redirects@^1.14.8: + version "1.15.3" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.3.tgz#fe2f3ef2690afce7e82ed0b44db08165b207123a" + integrity sha512-1VzOtuEM8pC9SFU1E+8KfTjZyMztRsgEfwQl44z8A25uy13jSzTj6dyK2Df52iV0vgHCfBwLhDWevLn95w5v6Q== + fork-ts-checker-webpack-plugin@^6.5.0: version "6.5.3" resolved "https://registry.yarnpkg.com/fork-ts-checker-webpack-plugin/-/fork-ts-checker-webpack-plugin-6.5.3.tgz#eda2eff6e22476a2688d10661688c47f611b37f3" @@ -5594,6 +5616,11 @@ parse-json@^5.0.0: json-parse-even-better-errors "^2.3.0" lines-and-columns "^1.1.6" +parse-ms@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/parse-ms/-/parse-ms-2.1.0.tgz#348565a753d4391fa524029956b172cb7753097d" + integrity sha512-kHt7kzLoS9VBZfUsiKjv43mr91ea+U05EyKkEtqp7vNbHxmaVuEqN7XxeEVnGrMtYOAxGrDElSi96K7EgO1zCA== + parse-numeric-range@^1.3.0: version "1.3.0" resolved "https://registry.yarnpkg.com/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz#7c63b61190d61e4d53a1197f0c83c47bb670ffa3" @@ -6006,6 +6033,13 @@ pretty-error@^4.0.0: lodash "^4.17.20" renderkid "^3.0.0" +pretty-ms@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/pretty-ms/-/pretty-ms-7.0.1.tgz#7d903eaab281f7d8e03c66f867e239dc32fb73e8" + integrity sha512-973driJZvxiGOQ5ONsFhOF/DtzPMOMtgC11kCpUrPGMTgqp2q/1gwzCquocrN33is0VZ5GFHXZYMM9l6h67v2Q== + dependencies: + parse-ms "^2.1.0" + pretty-time@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/pretty-time/-/pretty-time-1.1.0.tgz#ffb7429afabb8535c346a34e41873adf3d74dd0e"