diff --git a/docs/.eslintrc.yml b/docs/.eslintrc.yml
new file mode 100644
index 00000000..04785239
--- /dev/null
+++ b/docs/.eslintrc.yml
@@ -0,0 +1,15 @@
+env:
+ browser: true
+ es2021: true
+extends:
+ - eslint:recommended
+ - plugin:@typescript-eslint/recommended
+overrides: []
+parser: "@typescript-eslint/parser"
+parserOptions:
+ ecmaVersion: latest
+ sourceType: module
+plugins:
+ - "@typescript-eslint"
+rules:
+ "@typescript-eslint/no-non-null-assertion": off
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 00000000..6240da8b
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
diff --git a/docs/.prettierrc.yml b/docs/.prettierrc.yml
new file mode 100644
index 00000000..1b86d7e4
--- /dev/null
+++ b/docs/.prettierrc.yml
@@ -0,0 +1,7 @@
+$schema: "https://json.schemastore.org/prettierrc"
+tabWidth: 4
+semi: true
+singleQuote: false
+trailingComma: none
+printWidth: 100
+endOfLine: lf
diff --git a/docs/.vscode/extensions.json b/docs/.vscode/extensions.json
new file mode 100644
index 00000000..22a15055
--- /dev/null
+++ b/docs/.vscode/extensions.json
@@ -0,0 +1,4 @@
+{
+ "recommendations": ["astro-build.astro-vscode"],
+ "unwantedRecommendations": []
+}
diff --git a/docs/.vscode/launch.json b/docs/.vscode/launch.json
new file mode 100644
index 00000000..d6422097
--- /dev/null
+++ b/docs/.vscode/launch.json
@@ -0,0 +1,11 @@
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "command": "./node_modules/.bin/astro dev",
+ "name": "Development server",
+ "request": "launch",
+ "type": "node-terminal"
+ }
+ ]
+}
diff --git a/docs/Pipfile b/docs/Pipfile
deleted file mode 100644
index 6648fd16..00000000
--- a/docs/Pipfile
+++ /dev/null
@@ -1,12 +0,0 @@
-[[source]]
-url = "https://pypi.org/simple"
-verify_ssl = true
-name = "pypi"
-
-[packages]
-
-[dev-packages]
-menagerie-docs = "*"
-
-[requires]
-python_version = "3.11"
diff --git a/docs/Pipfile.lock b/docs/Pipfile.lock
deleted file mode 100644
index 4bb7eed8..00000000
--- a/docs/Pipfile.lock
+++ /dev/null
@@ -1,613 +0,0 @@
-{
- "_meta": {
- "hash": {
- "sha256": "e93f7f7087f635da529dc8dbaa56be872c12a26be4d8cfcaa9393f12fe7f1bda"
- },
- "pipfile-spec": 6,
- "requires": {
- "python_version": "3.11"
- },
- "sources": [
- {
- "name": "pypi",
- "url": "https://pypi.org/simple",
- "verify_ssl": true
- }
- ]
- },
- "default": {},
- "develop": {
- "attrs": {
- "hashes": [
- "sha256:29e95c7f6778868dbd49170f98f8818f78f3dc5e0e37c0b1f474e3561b240836",
- "sha256:c9227bfc2f01993c03f68db37d1d15c9690188323c067c641f1a35ca58185f99"
- ],
- "markers": "python_version >= '3.6'",
- "version": "==22.2.0"
- },
- "beautifulsoup4": {
- "hashes": [
- "sha256:2130a5ad7f513200fae61a17abb5e338ca980fa28c439c0571014bc0217e9591",
- "sha256:c5fceeaec29d09c84970e47c65f2f0efe57872f7cff494c9691a26ec0ff13234"
- ],
- "markers": "python_full_version >= '3.6.0'",
- "version": "==4.12.0"
- },
- "certifi": {
- "hashes": [
- "sha256:35824b4c3a97115964b408844d64aa14db1cc518f6562e8d7261699d1350a9e3",
- "sha256:4ad3232f5e926d6718ec31cfc1fcadfde020920e278684144551c91769c7bc18"
- ],
- "markers": "python_version >= '3.6'",
- "version": "==2022.12.7"
- },
- "charset-normalizer": {
- "hashes": [
- "sha256:04afa6387e2b282cf78ff3dbce20f0cc071c12dc8f685bd40960cc68644cfea6",
- "sha256:04eefcee095f58eaabe6dc3cc2262f3bcd776d2c67005880894f447b3f2cb9c1",
- "sha256:0be65ccf618c1e7ac9b849c315cc2e8a8751d9cfdaa43027d4f6624bd587ab7e",
- "sha256:0c95f12b74681e9ae127728f7e5409cbbef9cd914d5896ef238cc779b8152373",
- "sha256:0ca564606d2caafb0abe6d1b5311c2649e8071eb241b2d64e75a0d0065107e62",
- "sha256:10c93628d7497c81686e8e5e557aafa78f230cd9e77dd0c40032ef90c18f2230",
- "sha256:11d117e6c63e8f495412d37e7dc2e2fff09c34b2d09dbe2bee3c6229577818be",
- "sha256:11d3bcb7be35e7b1bba2c23beedac81ee893ac9871d0ba79effc7fc01167db6c",
- "sha256:12a2b561af122e3d94cdb97fe6fb2bb2b82cef0cdca131646fdb940a1eda04f0",
- "sha256:12d1a39aa6b8c6f6248bb54550efcc1c38ce0d8096a146638fd4738e42284448",
- "sha256:1435ae15108b1cb6fffbcea2af3d468683b7afed0169ad718451f8db5d1aff6f",
- "sha256:1c60b9c202d00052183c9be85e5eaf18a4ada0a47d188a83c8f5c5b23252f649",
- "sha256:1e8fcdd8f672a1c4fc8d0bd3a2b576b152d2a349782d1eb0f6b8e52e9954731d",
- "sha256:20064ead0717cf9a73a6d1e779b23d149b53daf971169289ed2ed43a71e8d3b0",
- "sha256:21fa558996782fc226b529fdd2ed7866c2c6ec91cee82735c98a197fae39f706",
- "sha256:22908891a380d50738e1f978667536f6c6b526a2064156203d418f4856d6e86a",
- "sha256:3160a0fd9754aab7d47f95a6b63ab355388d890163eb03b2d2b87ab0a30cfa59",
- "sha256:322102cdf1ab682ecc7d9b1c5eed4ec59657a65e1c146a0da342b78f4112db23",
- "sha256:34e0a2f9c370eb95597aae63bf85eb5e96826d81e3dcf88b8886012906f509b5",
- "sha256:3573d376454d956553c356df45bb824262c397c6e26ce43e8203c4c540ee0acb",
- "sha256:3747443b6a904001473370d7810aa19c3a180ccd52a7157aacc264a5ac79265e",
- "sha256:38e812a197bf8e71a59fe55b757a84c1f946d0ac114acafaafaf21667a7e169e",
- "sha256:3a06f32c9634a8705f4ca9946d667609f52cf130d5548881401f1eb2c39b1e2c",
- "sha256:3a5fc78f9e3f501a1614a98f7c54d3969f3ad9bba8ba3d9b438c3bc5d047dd28",
- "sha256:3d9098b479e78c85080c98e1e35ff40b4a31d8953102bb0fd7d1b6f8a2111a3d",
- "sha256:3dc5b6a8ecfdc5748a7e429782598e4f17ef378e3e272eeb1340ea57c9109f41",
- "sha256:4155b51ae05ed47199dc5b2a4e62abccb274cee6b01da5b895099b61b1982974",
- "sha256:49919f8400b5e49e961f320c735388ee686a62327e773fa5b3ce6721f7e785ce",
- "sha256:53d0a3fa5f8af98a1e261de6a3943ca631c526635eb5817a87a59d9a57ebf48f",
- "sha256:5f008525e02908b20e04707a4f704cd286d94718f48bb33edddc7d7b584dddc1",
- "sha256:628c985afb2c7d27a4800bfb609e03985aaecb42f955049957814e0491d4006d",
- "sha256:65ed923f84a6844de5fd29726b888e58c62820e0769b76565480e1fdc3d062f8",
- "sha256:6734e606355834f13445b6adc38b53c0fd45f1a56a9ba06c2058f86893ae8017",
- "sha256:6baf0baf0d5d265fa7944feb9f7451cc316bfe30e8df1a61b1bb08577c554f31",
- "sha256:6f4f4668e1831850ebcc2fd0b1cd11721947b6dc7c00bf1c6bd3c929ae14f2c7",
- "sha256:6f5c2e7bc8a4bf7c426599765b1bd33217ec84023033672c1e9a8b35eaeaaaf8",
- "sha256:6f6c7a8a57e9405cad7485f4c9d3172ae486cfef1344b5ddd8e5239582d7355e",
- "sha256:7381c66e0561c5757ffe616af869b916c8b4e42b367ab29fedc98481d1e74e14",
- "sha256:73dc03a6a7e30b7edc5b01b601e53e7fc924b04e1835e8e407c12c037e81adbd",
- "sha256:74db0052d985cf37fa111828d0dd230776ac99c740e1a758ad99094be4f1803d",
- "sha256:75f2568b4189dda1c567339b48cba4ac7384accb9c2a7ed655cd86b04055c795",
- "sha256:78cacd03e79d009d95635e7d6ff12c21eb89b894c354bd2b2ed0b4763373693b",
- "sha256:80d1543d58bd3d6c271b66abf454d437a438dff01c3e62fdbcd68f2a11310d4b",
- "sha256:830d2948a5ec37c386d3170c483063798d7879037492540f10a475e3fd6f244b",
- "sha256:891cf9b48776b5c61c700b55a598621fdb7b1e301a550365571e9624f270c203",
- "sha256:8f25e17ab3039b05f762b0a55ae0b3632b2e073d9c8fc88e89aca31a6198e88f",
- "sha256:9a3267620866c9d17b959a84dd0bd2d45719b817245e49371ead79ed4f710d19",
- "sha256:a04f86f41a8916fe45ac5024ec477f41f886b3c435da2d4e3d2709b22ab02af1",
- "sha256:aaf53a6cebad0eae578f062c7d462155eada9c172bd8c4d250b8c1d8eb7f916a",
- "sha256:abc1185d79f47c0a7aaf7e2412a0eb2c03b724581139193d2d82b3ad8cbb00ac",
- "sha256:ac0aa6cd53ab9a31d397f8303f92c42f534693528fafbdb997c82bae6e477ad9",
- "sha256:ac3775e3311661d4adace3697a52ac0bab17edd166087d493b52d4f4f553f9f0",
- "sha256:b06f0d3bf045158d2fb8837c5785fe9ff9b8c93358be64461a1089f5da983137",
- "sha256:b116502087ce8a6b7a5f1814568ccbd0e9f6cfd99948aa59b0e241dc57cf739f",
- "sha256:b82fab78e0b1329e183a65260581de4375f619167478dddab510c6c6fb04d9b6",
- "sha256:bd7163182133c0c7701b25e604cf1611c0d87712e56e88e7ee5d72deab3e76b5",
- "sha256:c36bcbc0d5174a80d6cccf43a0ecaca44e81d25be4b7f90f0ed7bcfbb5a00909",
- "sha256:c3af8e0f07399d3176b179f2e2634c3ce9c1301379a6b8c9c9aeecd481da494f",
- "sha256:c84132a54c750fda57729d1e2599bb598f5fa0344085dbde5003ba429a4798c0",
- "sha256:cb7b2ab0188829593b9de646545175547a70d9a6e2b63bf2cd87a0a391599324",
- "sha256:cca4def576f47a09a943666b8f829606bcb17e2bc2d5911a46c8f8da45f56755",
- "sha256:cf6511efa4801b9b38dc5546d7547d5b5c6ef4b081c60b23e4d941d0eba9cbeb",
- "sha256:d16fd5252f883eb074ca55cb622bc0bee49b979ae4e8639fff6ca3ff44f9f854",
- "sha256:d2686f91611f9e17f4548dbf050e75b079bbc2a82be565832bc8ea9047b61c8c",
- "sha256:d7fc3fca01da18fbabe4625d64bb612b533533ed10045a2ac3dd194bfa656b60",
- "sha256:dd5653e67b149503c68c4018bf07e42eeed6b4e956b24c00ccdf93ac79cdff84",
- "sha256:de5695a6f1d8340b12a5d6d4484290ee74d61e467c39ff03b39e30df62cf83a0",
- "sha256:e0ac8959c929593fee38da1c2b64ee9778733cdf03c482c9ff1d508b6b593b2b",
- "sha256:e1b25e3ad6c909f398df8921780d6a3d120d8c09466720226fc621605b6f92b1",
- "sha256:e633940f28c1e913615fd624fcdd72fdba807bf53ea6925d6a588e84e1151531",
- "sha256:e89df2958e5159b811af9ff0f92614dabf4ff617c03a4c1c6ff53bf1c399e0e1",
- "sha256:ea9f9c6034ea2d93d9147818f17c2a0860d41b71c38b9ce4d55f21b6f9165a11",
- "sha256:f645caaf0008bacf349875a974220f1f1da349c5dbe7c4ec93048cdc785a3326",
- "sha256:f8303414c7b03f794347ad062c0516cee0e15f7a612abd0ce1e25caf6ceb47df",
- "sha256:fca62a8301b605b954ad2e9c3666f9d97f63872aa4efcae5492baca2056b74ab"
- ],
- "markers": "python_full_version >= '3.7.0'",
- "version": "==3.1.0"
- },
- "click": {
- "hashes": [
- "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e",
- "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==8.1.3"
- },
- "dataclasses-json": {
- "hashes": [
- "sha256:bc285b5f892094c3a53d558858a88553dd6a61a11ab1a8128a0e554385dcc5dd",
- "sha256:c2c11bc8214fbf709ffc369d11446ff6945254a7f09128154a7620613d8fda90"
- ],
- "markers": "python_version >= '3.6'",
- "version": "==0.5.7"
- },
- "elementpath": {
- "hashes": [
- "sha256:2b1b524223d70fd6dd63a36b9bc32e4919c96a272c2d1454094c4d85086bc6f8",
- "sha256:dbd7eba3cf0b3b4934f627ba24851a3e0798ef2bc9104555a4cd831f2e6e8e14"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==4.1.0"
- },
- "htmlmin": {
- "hashes": [
- "sha256:50c1ef4630374a5d723900096a961cff426dff46b48f34d194a81bbe14eca178"
- ],
- "version": "==0.1.12"
- },
- "idna": {
- "hashes": [
- "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4",
- "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2"
- ],
- "markers": "python_version >= '3.5'",
- "version": "==3.4"
- },
- "jinja2": {
- "hashes": [
- "sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852",
- "sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==3.1.2"
- },
- "json-minify": {
- "hashes": [
- "sha256:268e6966c0f1dcb32ac54e1d047b83deba9ce711c0763ceba63f26d3aeedf656",
- "sha256:499717626144a533d64ed4a1513976cf2212958b6806a66e07dd8e22207df559"
- ],
- "version": "==0.3.0"
- },
- "json-schema-for-humans": {
- "hashes": [
- "sha256:1e34f1ae053c0884a52bcfc415f8de10a9dc918554523912f53015d202549f37",
- "sha256:62a72dd2edb064fb6f2cb6939670185b80a79317b1e7cdb2132634287b142493"
- ],
- "markers": "python_version >= '3.7' and python_version < '4.0'",
- "version": "==0.44.4"
- },
- "jsonschema": {
- "hashes": [
- "sha256:0f864437ab8b6076ba6707453ef8f98a6a0d512a80e93f8abdb676f737ecb60d",
- "sha256:a870ad254da1a8ca84b6a2905cac29d265f805acc57af304784962a2aa6508f6"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==4.17.3"
- },
- "libsass": {
- "hashes": [
- "sha256:081e256ab3c5f3f09c7b8dea3bf3bf5e64a97c6995fd9eea880639b3f93a9f9a",
- "sha256:3ab5ad18e47db560f4f0c09e3d28cf3bb1a44711257488ac2adad69f4f7f8425",
- "sha256:65455a2728b696b62100eb5932604aa13a29f4ac9a305d95773c14aaa7200aaf",
- "sha256:89c5ce497fcf3aba1dd1b19aae93b99f68257e5f2026b731b00a872f13324c7f",
- "sha256:f1efc1b612299c88aec9e39d6ca0c266d360daa5b19d9430bdeaffffa86993f9"
- ],
- "markers": "python_version >= '3.6'",
- "version": "==0.22.0"
- },
- "markdown": {
- "hashes": [
- "sha256:31b5b491868dcc87d6c24b7e3d19a0d730d59d3e46f4eea6430a321bed387a49",
- "sha256:96c3ba1261de2f7547b46a00ea8463832c921d3f9d6aba3f255a6f71386db20c"
- ],
- "markers": "python_version >= '3.6'",
- "version": "==3.3.4"
- },
- "markdown2": {
- "hashes": [
- "sha256:7d49ca871d3e0e412c65d7d21fcbc13ae897f7876f3e5f14dd4db3b7fbf27f10",
- "sha256:90475aca3d9c8e7df6d70c51de5bbbe9edf7fcf6a380bd1044d321500f5445da"
- ],
- "markers": "python_version >= '3.5' and python_version < '4'",
- "version": "==2.4.8"
- },
- "markupsafe": {
- "hashes": [
- "sha256:0576fe974b40a400449768941d5d0858cc624e3249dfd1e0c33674e5c7ca7aed",
- "sha256:085fd3201e7b12809f9e6e9bc1e5c96a368c8523fad5afb02afe3c051ae4afcc",
- "sha256:090376d812fb6ac5f171e5938e82e7f2d7adc2b629101cec0db8b267815c85e2",
- "sha256:0b462104ba25f1ac006fdab8b6a01ebbfbce9ed37fd37fd4acd70c67c973e460",
- "sha256:137678c63c977754abe9086a3ec011e8fd985ab90631145dfb9294ad09c102a7",
- "sha256:1bea30e9bf331f3fef67e0a3877b2288593c98a21ccb2cf29b74c581a4eb3af0",
- "sha256:22152d00bf4a9c7c83960521fc558f55a1adbc0631fbb00a9471e097b19d72e1",
- "sha256:22731d79ed2eb25059ae3df1dfc9cb1546691cc41f4e3130fe6bfbc3ecbbecfa",
- "sha256:2298c859cfc5463f1b64bd55cb3e602528db6fa0f3cfd568d3605c50678f8f03",
- "sha256:28057e985dace2f478e042eaa15606c7efccb700797660629da387eb289b9323",
- "sha256:2e7821bffe00aa6bd07a23913b7f4e01328c3d5cc0b40b36c0bd81d362faeb65",
- "sha256:2ec4f2d48ae59bbb9d1f9d7efb9236ab81429a764dedca114f5fdabbc3788013",
- "sha256:340bea174e9761308703ae988e982005aedf427de816d1afe98147668cc03036",
- "sha256:40627dcf047dadb22cd25ea7ecfe9cbf3bbbad0482ee5920b582f3809c97654f",
- "sha256:40dfd3fefbef579ee058f139733ac336312663c6706d1163b82b3003fb1925c4",
- "sha256:4cf06cdc1dda95223e9d2d3c58d3b178aa5dacb35ee7e3bbac10e4e1faacb419",
- "sha256:50c42830a633fa0cf9e7d27664637532791bfc31c731a87b202d2d8ac40c3ea2",
- "sha256:55f44b440d491028addb3b88f72207d71eeebfb7b5dbf0643f7c023ae1fba619",
- "sha256:608e7073dfa9e38a85d38474c082d4281f4ce276ac0010224eaba11e929dd53a",
- "sha256:63ba06c9941e46fa389d389644e2d8225e0e3e5ebcc4ff1ea8506dce646f8c8a",
- "sha256:65608c35bfb8a76763f37036547f7adfd09270fbdbf96608be2bead319728fcd",
- "sha256:665a36ae6f8f20a4676b53224e33d456a6f5a72657d9c83c2aa00765072f31f7",
- "sha256:6d6607f98fcf17e534162f0709aaad3ab7a96032723d8ac8750ffe17ae5a0666",
- "sha256:7313ce6a199651c4ed9d7e4cfb4aa56fe923b1adf9af3b420ee14e6d9a73df65",
- "sha256:7668b52e102d0ed87cb082380a7e2e1e78737ddecdde129acadb0eccc5423859",
- "sha256:7df70907e00c970c60b9ef2938d894a9381f38e6b9db73c5be35e59d92e06625",
- "sha256:7e007132af78ea9df29495dbf7b5824cb71648d7133cf7848a2a5dd00d36f9ff",
- "sha256:835fb5e38fd89328e9c81067fd642b3593c33e1e17e2fdbf77f5676abb14a156",
- "sha256:8bca7e26c1dd751236cfb0c6c72d4ad61d986e9a41bbf76cb445f69488b2a2bd",
- "sha256:8db032bf0ce9022a8e41a22598eefc802314e81b879ae093f36ce9ddf39ab1ba",
- "sha256:99625a92da8229df6d44335e6fcc558a5037dd0a760e11d84be2260e6f37002f",
- "sha256:9cad97ab29dfc3f0249b483412c85c8ef4766d96cdf9dcf5a1e3caa3f3661cf1",
- "sha256:a4abaec6ca3ad8660690236d11bfe28dfd707778e2442b45addd2f086d6ef094",
- "sha256:a6e40afa7f45939ca356f348c8e23048e02cb109ced1eb8420961b2f40fb373a",
- "sha256:a6f2fcca746e8d5910e18782f976489939d54a91f9411c32051b4aab2bd7c513",
- "sha256:a806db027852538d2ad7555b203300173dd1b77ba116de92da9afbc3a3be3eed",
- "sha256:abcabc8c2b26036d62d4c746381a6f7cf60aafcc653198ad678306986b09450d",
- "sha256:b8526c6d437855442cdd3d87eede9c425c4445ea011ca38d937db299382e6fa3",
- "sha256:bb06feb762bade6bf3c8b844462274db0c76acc95c52abe8dbed28ae3d44a147",
- "sha256:c0a33bc9f02c2b17c3ea382f91b4db0e6cde90b63b296422a939886a7a80de1c",
- "sha256:c4a549890a45f57f1ebf99c067a4ad0cb423a05544accaf2b065246827ed9603",
- "sha256:ca244fa73f50a800cf8c3ebf7fd93149ec37f5cb9596aa8873ae2c1d23498601",
- "sha256:cf877ab4ed6e302ec1d04952ca358b381a882fbd9d1b07cccbfd61783561f98a",
- "sha256:d9d971ec1e79906046aa3ca266de79eac42f1dbf3612a05dc9368125952bd1a1",
- "sha256:da25303d91526aac3672ee6d49a2f3db2d9502a4a60b55519feb1a4c7714e07d",
- "sha256:e55e40ff0cc8cc5c07996915ad367fa47da6b3fc091fdadca7f5403239c5fec3",
- "sha256:f03a532d7dee1bed20bc4884194a16160a2de9ffc6354b3878ec9682bb623c54",
- "sha256:f1cd098434e83e656abf198f103a8207a8187c0fc110306691a2e94a78d0abb2",
- "sha256:f2bfb563d0211ce16b63c7cb9395d2c682a23187f54c3d79bfec33e6705473c6",
- "sha256:f8ffb705ffcf5ddd0e80b65ddf7bed7ee4f5a441ea7d3419e861a12eaf41af58"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==2.1.2"
- },
- "marshmallow": {
- "hashes": [
- "sha256:90032c0fd650ce94b6ec6dc8dfeb0e3ff50c144586462c389b81a07205bedb78",
- "sha256:93f0958568da045b0021ec6aeb7ac37c81bfcccbb9a0e7ed8559885070b3a19b"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==3.19.0"
- },
- "marshmallow-enum": {
- "hashes": [
- "sha256:38e697e11f45a8e64b4a1e664000897c659b60aa57bfa18d44e226a9920b6e58",
- "sha256:57161ab3dbfde4f57adeb12090f39592e992b9c86d206d02f6bd03ebec60f072"
- ],
- "version": "==1.5.1"
- },
- "menagerie-docs": {
- "hashes": [
- "sha256:ad6ff178b3edc493b7e031d932616e4aaef788c2e796494e729fb2fb96c334eb",
- "sha256:bfd5b78c8a2931983a1941ee2e96204b93e5ff90f5bbc0e0178c763de42b844f"
- ],
- "index": "pypi",
- "version": "==0.1.14"
- },
- "more-itertools": {
- "hashes": [
- "sha256:cabaa341ad0389ea83c17a94566a53ae4c9d07349861ecb14dc6d0345cf9ac5d",
- "sha256:d2bc7f02446e86a68911e58ded76d6561eea00cddfb2a91e7019bbb586c799f3"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==9.1.0"
- },
- "mypy-extensions": {
- "hashes": [
- "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d",
- "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"
- ],
- "markers": "python_version >= '3.5'",
- "version": "==1.0.0"
- },
- "ndicts": {
- "hashes": [
- "sha256:010b0c94180fe89e7e0d5fa89909c4bd7784c52d56908d4d776337c9358378e9",
- "sha256:1a1f31cdb770c037c9cc9bc27a8493e43bfe035a606d3630c2e3d14eabe7bfbf"
- ],
- "markers": "python_version >= '3.8' and python_version < '4.0'",
- "version": "==0.3.0"
- },
- "packaging": {
- "hashes": [
- "sha256:714ac14496c3e68c99c29b00845f7a2b85f3bb6f1078fd9f72fd20f0570002b2",
- "sha256:b6ad297f8907de0fa2fe1ccbd26fdaf387f5f47c7275fedf8cce89f99446cf97"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==23.0"
- },
- "pillow": {
- "hashes": [
- "sha256:013016af6b3a12a2f40b704677f8b51f72cb007dac785a9933d5c86a72a7fe33",
- "sha256:0845adc64fe9886db00f5ab68c4a8cd933ab749a87747555cec1c95acea64b0b",
- "sha256:0884ba7b515163a1a05440a138adeb722b8a6ae2c2b33aea93ea3118dd3a899e",
- "sha256:09b89ddc95c248ee788328528e6a2996e09eaccddeeb82a5356e92645733be35",
- "sha256:0dd4c681b82214b36273c18ca7ee87065a50e013112eea7d78c7a1b89a739153",
- "sha256:0e51f608da093e5d9038c592b5b575cadc12fd748af1479b5e858045fff955a9",
- "sha256:0f3269304c1a7ce82f1759c12ce731ef9b6e95b6df829dccd9fe42912cc48569",
- "sha256:16a8df99701f9095bea8a6c4b3197da105df6f74e6176c5b410bc2df2fd29a57",
- "sha256:19005a8e58b7c1796bc0167862b1f54a64d3b44ee5d48152b06bb861458bc0f8",
- "sha256:1b4b4e9dda4f4e4c4e6896f93e84a8f0bcca3b059de9ddf67dac3c334b1195e1",
- "sha256:28676836c7796805914b76b1837a40f76827ee0d5398f72f7dcc634bae7c6264",
- "sha256:2968c58feca624bb6c8502f9564dd187d0e1389964898f5e9e1fbc8533169157",
- "sha256:3f4cc516e0b264c8d4ccd6b6cbc69a07c6d582d8337df79be1e15a5056b258c9",
- "sha256:3fa1284762aacca6dc97474ee9c16f83990b8eeb6697f2ba17140d54b453e133",
- "sha256:43521ce2c4b865d385e78579a082b6ad1166ebed2b1a2293c3be1d68dd7ca3b9",
- "sha256:451f10ef963918e65b8869e17d67db5e2f4ab40e716ee6ce7129b0cde2876eab",
- "sha256:46c259e87199041583658457372a183636ae8cd56dbf3f0755e0f376a7f9d0e6",
- "sha256:46f39cab8bbf4a384ba7cb0bc8bae7b7062b6a11cfac1ca4bc144dea90d4a9f5",
- "sha256:519e14e2c49fcf7616d6d2cfc5c70adae95682ae20f0395e9280db85e8d6c4df",
- "sha256:53dcb50fbdc3fb2c55431a9b30caeb2f7027fcd2aeb501459464f0214200a503",
- "sha256:54614444887e0d3043557d9dbc697dbb16cfb5a35d672b7a0fcc1ed0cf1c600b",
- "sha256:575d8912dca808edd9acd6f7795199332696d3469665ef26163cd090fa1f8bfa",
- "sha256:5dd5a9c3091a0f414a963d427f920368e2b6a4c2f7527fdd82cde8ef0bc7a327",
- "sha256:5f532a2ad4d174eb73494e7397988e22bf427f91acc8e6ebf5bb10597b49c493",
- "sha256:60e7da3a3ad1812c128750fc1bc14a7ceeb8d29f77e0a2356a8fb2aa8925287d",
- "sha256:653d7fb2df65efefbcbf81ef5fe5e5be931f1ee4332c2893ca638c9b11a409c4",
- "sha256:6663977496d616b618b6cfa43ec86e479ee62b942e1da76a2c3daa1c75933ef4",
- "sha256:6abfb51a82e919e3933eb137e17c4ae9c0475a25508ea88993bb59faf82f3b35",
- "sha256:6c6b1389ed66cdd174d040105123a5a1bc91d0aa7059c7261d20e583b6d8cbd2",
- "sha256:6d9dfb9959a3b0039ee06c1a1a90dc23bac3b430842dcb97908ddde05870601c",
- "sha256:765cb54c0b8724a7c12c55146ae4647e0274a839fb6de7bcba841e04298e1011",
- "sha256:7a21222644ab69ddd9967cfe6f2bb420b460dae4289c9d40ff9a4896e7c35c9a",
- "sha256:7ac7594397698f77bce84382929747130765f66406dc2cd8b4ab4da68ade4c6e",
- "sha256:7cfc287da09f9d2a7ec146ee4d72d6ea1342e770d975e49a8621bf54eaa8f30f",
- "sha256:83125753a60cfc8c412de5896d10a0a405e0bd88d0470ad82e0869ddf0cb3848",
- "sha256:847b114580c5cc9ebaf216dd8c8dbc6b00a3b7ab0131e173d7120e6deade1f57",
- "sha256:87708d78a14d56a990fbf4f9cb350b7d89ee8988705e58e39bdf4d82c149210f",
- "sha256:8a2b5874d17e72dfb80d917213abd55d7e1ed2479f38f001f264f7ce7bae757c",
- "sha256:8f127e7b028900421cad64f51f75c051b628db17fb00e099eb148761eed598c9",
- "sha256:94cdff45173b1919350601f82d61365e792895e3c3a3443cf99819e6fbf717a5",
- "sha256:99d92d148dd03fd19d16175b6d355cc1b01faf80dae93c6c3eb4163709edc0a9",
- "sha256:9a3049a10261d7f2b6514d35bbb7a4dfc3ece4c4de14ef5876c4b7a23a0e566d",
- "sha256:9d9a62576b68cd90f7075876f4e8444487db5eeea0e4df3ba298ee38a8d067b0",
- "sha256:9e5f94742033898bfe84c93c831a6f552bb629448d4072dd312306bab3bd96f1",
- "sha256:a1c2d7780448eb93fbcc3789bf3916aa5720d942e37945f4056680317f1cd23e",
- "sha256:a2e0f87144fcbbe54297cae708c5e7f9da21a4646523456b00cc956bd4c65815",
- "sha256:a4dfdae195335abb4e89cc9762b2edc524f3c6e80d647a9a81bf81e17e3fb6f0",
- "sha256:a96e6e23f2b79433390273eaf8cc94fec9c6370842e577ab10dabdcc7ea0a66b",
- "sha256:aabdab8ec1e7ca7f1434d042bf8b1e92056245fb179790dc97ed040361f16bfd",
- "sha256:b222090c455d6d1a64e6b7bb5f4035c4dff479e22455c9eaa1bdd4c75b52c80c",
- "sha256:b52ff4f4e002f828ea6483faf4c4e8deea8d743cf801b74910243c58acc6eda3",
- "sha256:b70756ec9417c34e097f987b4d8c510975216ad26ba6e57ccb53bc758f490dab",
- "sha256:b8c2f6eb0df979ee99433d8b3f6d193d9590f735cf12274c108bd954e30ca858",
- "sha256:b9b752ab91e78234941e44abdecc07f1f0d8f51fb62941d32995b8161f68cfe5",
- "sha256:ba6612b6548220ff5e9df85261bddc811a057b0b465a1226b39bfb8550616aee",
- "sha256:bd752c5ff1b4a870b7661234694f24b1d2b9076b8bf337321a814c612665f343",
- "sha256:c3c4ed2ff6760e98d262e0cc9c9a7f7b8a9f61aa4d47c58835cdaf7b0b8811bb",
- "sha256:c5c1362c14aee73f50143d74389b2c158707b4abce2cb055b7ad37ce60738d47",
- "sha256:cb362e3b0976dc994857391b776ddaa8c13c28a16f80ac6522c23d5257156bed",
- "sha256:d197df5489004db87d90b918033edbeee0bd6df3848a204bca3ff0a903bef837",
- "sha256:d3b56206244dc8711f7e8b7d6cad4663917cd5b2d950799425076681e8766286",
- "sha256:d5b2f8a31bd43e0f18172d8ac82347c8f37ef3e0b414431157718aa234991b28",
- "sha256:d7081c084ceb58278dd3cf81f836bc818978c0ccc770cbbb202125ddabec6628",
- "sha256:db74f5562c09953b2c5f8ec4b7dfd3f5421f31811e97d1dbc0a7c93d6e3a24df",
- "sha256:df41112ccce5d47770a0c13651479fbcd8793f34232a2dd9faeccb75eb5d0d0d",
- "sha256:e1339790c083c5a4de48f688b4841f18df839eb3c9584a770cbd818b33e26d5d",
- "sha256:e621b0246192d3b9cb1dc62c78cfa4c6f6d2ddc0ec207d43c0dedecb914f152a",
- "sha256:e8c5cf126889a4de385c02a2c3d3aba4b00f70234bfddae82a5eaa3ee6d5e3e6",
- "sha256:e9d7747847c53a16a729b6ee5e737cf170f7a16611c143d95aa60a109a59c336",
- "sha256:eaef5d2de3c7e9b21f1e762f289d17b726c2239a42b11e25446abf82b26ac132",
- "sha256:ed3e4b4e1e6de75fdc16d3259098de7c6571b1a6cc863b1a49e7d3d53e036070",
- "sha256:ef21af928e807f10bf4141cad4746eee692a0dd3ff56cfb25fce076ec3cc8abe",
- "sha256:f09598b416ba39a8f489c124447b007fe865f786a89dbfa48bb5cf395693132a",
- "sha256:f0caf4a5dcf610d96c3bd32932bfac8aee61c96e60481c2a0ea58da435e25acd",
- "sha256:f6e78171be3fb7941f9910ea15b4b14ec27725865a73c15277bc39f5ca4f8391",
- "sha256:f715c32e774a60a337b2bb8ad9839b4abf75b267a0f18806f6f4f5f1688c4b5a",
- "sha256:fb5c1ad6bad98c57482236a21bf985ab0ef42bd51f7ad4e4538e89a997624e12"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==9.4.0"
- },
- "pygments": {
- "hashes": [
- "sha256:b3ed06a9e8ac9a9aae5a6f5dbe78a8a58655d17b43b93c078f094ddc476ae297",
- "sha256:fa7bd7bd2771287c0de303af8bfdfc731f51bd2c6a47ab69d117138893b82717"
- ],
- "markers": "python_version >= '3.6'",
- "version": "==2.14.0"
- },
- "pyrsistent": {
- "hashes": [
- "sha256:016ad1afadf318eb7911baa24b049909f7f3bb2c5b1ed7b6a8f21db21ea3faa8",
- "sha256:1a2994773706bbb4995c31a97bc94f1418314923bd1048c6d964837040376440",
- "sha256:20460ac0ea439a3e79caa1dbd560344b64ed75e85d8703943e0b66c2a6150e4a",
- "sha256:3311cb4237a341aa52ab8448c27e3a9931e2ee09561ad150ba94e4cfd3fc888c",
- "sha256:3a8cb235fa6d3fd7aae6a4f1429bbb1fec1577d978098da1252f0489937786f3",
- "sha256:3ab2204234c0ecd8b9368dbd6a53e83c3d4f3cab10ecaf6d0e772f456c442393",
- "sha256:42ac0b2f44607eb92ae88609eda931a4f0dfa03038c44c772e07f43e738bcac9",
- "sha256:49c32f216c17148695ca0e02a5c521e28a4ee6c5089f97e34fe24163113722da",
- "sha256:4b774f9288dda8d425adb6544e5903f1fb6c273ab3128a355c6b972b7df39dcf",
- "sha256:4c18264cb84b5e68e7085a43723f9e4c1fd1d935ab240ce02c0324a8e01ccb64",
- "sha256:5a474fb80f5e0d6c9394d8db0fc19e90fa540b82ee52dba7d246a7791712f74a",
- "sha256:64220c429e42a7150f4bfd280f6f4bb2850f95956bde93c6fda1b70507af6ef3",
- "sha256:878433581fc23e906d947a6814336eee031a00e6defba224234169ae3d3d6a98",
- "sha256:99abb85579e2165bd8522f0c0138864da97847875ecbd45f3e7e2af569bfc6f2",
- "sha256:a2471f3f8693101975b1ff85ffd19bb7ca7dd7c38f8a81701f67d6b4f97b87d8",
- "sha256:aeda827381f5e5d65cced3024126529ddc4289d944f75e090572c77ceb19adbf",
- "sha256:b735e538f74ec31378f5a1e3886a26d2ca6351106b4dfde376a26fc32a044edc",
- "sha256:c147257a92374fde8498491f53ffa8f4822cd70c0d85037e09028e478cababb7",
- "sha256:c4db1bd596fefd66b296a3d5d943c94f4fac5bcd13e99bffe2ba6a759d959a28",
- "sha256:c74bed51f9b41c48366a286395c67f4e894374306b197e62810e0fdaf2364da2",
- "sha256:c9bb60a40a0ab9aba40a59f68214eed5a29c6274c83b2cc206a359c4a89fa41b",
- "sha256:cc5d149f31706762c1f8bda2e8c4f8fead6e80312e3692619a75301d3dbb819a",
- "sha256:ccf0d6bd208f8111179f0c26fdf84ed7c3891982f2edaeae7422575f47e66b64",
- "sha256:e42296a09e83028b3476f7073fcb69ffebac0e66dbbfd1bd847d61f74db30f19",
- "sha256:e8f2b814a3dc6225964fa03d8582c6e0b6650d68a232df41e3cc1b66a5d2f8d1",
- "sha256:f0774bf48631f3a20471dd7c5989657b639fd2d285b861237ea9e82c36a415a9",
- "sha256:f0e7c4b2f77593871e918be000b96c8107da48444d57005b6a6bc61fb4331b2c"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==0.19.3"
- },
- "pytz": {
- "hashes": [
- "sha256:1d8ce29db189191fb55338ee6d0387d82ab59f3d00eac103412d64e0ebd0c588",
- "sha256:a151b3abb88eda1d4e34a9814df37de2a80e301e68ba0fd856fb9b46bfbbbffb"
- ],
- "version": "==2023.3"
- },
- "pyyaml": {
- "hashes": [
- "sha256:01b45c0191e6d66c470b6cf1b9531a771a83c1c4208272ead47a3ae4f2f603bf",
- "sha256:0283c35a6a9fbf047493e3a0ce8d79ef5030852c51e9d911a27badfde0605293",
- "sha256:055d937d65826939cb044fc8c9b08889e8c743fdc6a32b33e2390f66013e449b",
- "sha256:07751360502caac1c067a8132d150cf3d61339af5691fe9e87803040dbc5db57",
- "sha256:0b4624f379dab24d3725ffde76559cff63d9ec94e1736b556dacdfebe5ab6d4b",
- "sha256:0ce82d761c532fe4ec3f87fc45688bdd3a4c1dc5e0b4a19814b9009a29baefd4",
- "sha256:1e4747bc279b4f613a09eb64bba2ba602d8a6664c6ce6396a4d0cd413a50ce07",
- "sha256:213c60cd50106436cc818accf5baa1aba61c0189ff610f64f4a3e8c6726218ba",
- "sha256:231710d57adfd809ef5d34183b8ed1eeae3f76459c18fb4a0b373ad56bedcdd9",
- "sha256:277a0ef2981ca40581a47093e9e2d13b3f1fbbeffae064c1d21bfceba2030287",
- "sha256:2cd5df3de48857ed0544b34e2d40e9fac445930039f3cfe4bcc592a1f836d513",
- "sha256:40527857252b61eacd1d9af500c3337ba8deb8fc298940291486c465c8b46ec0",
- "sha256:432557aa2c09802be39460360ddffd48156e30721f5e8d917f01d31694216782",
- "sha256:473f9edb243cb1935ab5a084eb238d842fb8f404ed2193a915d1784b5a6b5fc0",
- "sha256:48c346915c114f5fdb3ead70312bd042a953a8ce5c7106d5bfb1a5254e47da92",
- "sha256:50602afada6d6cbfad699b0c7bb50d5ccffa7e46a3d738092afddc1f9758427f",
- "sha256:68fb519c14306fec9720a2a5b45bc9f0c8d1b9c72adf45c37baedfcd949c35a2",
- "sha256:77f396e6ef4c73fdc33a9157446466f1cff553d979bd00ecb64385760c6babdc",
- "sha256:81957921f441d50af23654aa6c5e5eaf9b06aba7f0a19c18a538dc7ef291c5a1",
- "sha256:819b3830a1543db06c4d4b865e70ded25be52a2e0631ccd2f6a47a2822f2fd7c",
- "sha256:897b80890765f037df3403d22bab41627ca8811ae55e9a722fd0392850ec4d86",
- "sha256:98c4d36e99714e55cfbaaee6dd5badbc9a1ec339ebfc3b1f52e293aee6bb71a4",
- "sha256:9df7ed3b3d2e0ecfe09e14741b857df43adb5a3ddadc919a2d94fbdf78fea53c",
- "sha256:9fa600030013c4de8165339db93d182b9431076eb98eb40ee068700c9c813e34",
- "sha256:a80a78046a72361de73f8f395f1f1e49f956c6be882eed58505a15f3e430962b",
- "sha256:afa17f5bc4d1b10afd4466fd3a44dc0e245382deca5b3c353d8b757f9e3ecb8d",
- "sha256:b3d267842bf12586ba6c734f89d1f5b871df0273157918b0ccefa29deb05c21c",
- "sha256:b5b9eccad747aabaaffbc6064800670f0c297e52c12754eb1d976c57e4f74dcb",
- "sha256:bfaef573a63ba8923503d27530362590ff4f576c626d86a9fed95822a8255fd7",
- "sha256:c5687b8d43cf58545ade1fe3e055f70eac7a5a1a0bf42824308d868289a95737",
- "sha256:cba8c411ef271aa037d7357a2bc8f9ee8b58b9965831d9e51baf703280dc73d3",
- "sha256:d15a181d1ecd0d4270dc32edb46f7cb7733c7c508857278d3d378d14d606db2d",
- "sha256:d4b0ba9512519522b118090257be113b9468d804b19d63c71dbcf4a48fa32358",
- "sha256:d4db7c7aef085872ef65a8fd7d6d09a14ae91f691dec3e87ee5ee0539d516f53",
- "sha256:d4eccecf9adf6fbcc6861a38015c2a64f38b9d94838ac1810a9023a0609e1b78",
- "sha256:d67d839ede4ed1b28a4e8909735fc992a923cdb84e618544973d7dfc71540803",
- "sha256:daf496c58a8c52083df09b80c860005194014c3698698d1a57cbcfa182142a3a",
- "sha256:dbad0e9d368bb989f4515da330b88a057617d16b6a8245084f1b05400f24609f",
- "sha256:e61ceaab6f49fb8bdfaa0f92c4b57bcfbea54c09277b1b4f7ac376bfb7a7c174",
- "sha256:f84fbc98b019fef2ee9a1cb3ce93e3187a6df0b2538a651bfb890254ba9f90b5"
- ],
- "markers": "python_version >= '3.6'",
- "version": "==6.0"
- },
- "rcssmin": {
- "hashes": [
- "sha256:271e3d2f8614a6d4637ed8fff3d90007f03e2a654cd9444f37d888797662ba72",
- "sha256:35da6a6999e9e2c5b0e691b42ed56cc479373e0ecab33ef5277dfecce625e44a",
- "sha256:42576d95dfad53d77df2e68dfdec95b89b10fad320f241f1af3ca1438578254a",
- "sha256:4f9400b4366d29f5f5446f58e78549afa8338e6a59740c73115e9f6ac413dc64",
- "sha256:705c9112d0ed54ea40aecf97e7fd29bdf0f1c46d278a32d8f957f31dde90778a",
- "sha256:79421230dd67c37ec61ed9892813d2b839b68f2f48ef55c75f976e81701d60b4",
- "sha256:868215e1fd0e92a6122e0ed5973dfc7bb8330fe1e92274d05b2585253b38c0ca",
- "sha256:8a26fec3c1e6b7a3765ccbaccc20fbb5c0ed3422cc381e01a2607f08d7621c44",
- "sha256:8fcfd10ae2a1c4ce231a33013f2539e07c3836bf17cc945cc25cc30bf8e68e45",
- "sha256:908fe072efd2432fb0975a61124609a8e05021367f6a3463d45f5e3e74c4fdda",
- "sha256:914e589f40573035006913861ed2adc28fbe70082a8b6bff5be7ee430b7b5c2e",
- "sha256:a04d58a2a21e9a089306d3f99c4b12bf5b656a79c198ef2321e80f8fd9afab06",
- "sha256:a417735d4023d47d048a6288c88dbceadd20abaaf65a11bb4fda1e8458057019",
- "sha256:c30f8bc839747b6da59274e0c6e4361915d66532e26448d589cb2b1846d7bf11",
- "sha256:c7278c1c25bb90d8e554df92cfb3b6a1195004ead50f764653d3093933ee0877",
- "sha256:c7728e3b546b1b6ea08cab721e8e21409dbcc11b881d0b87d10b0be8930af2a2",
- "sha256:cf74d7ea5e191f0f344b354eed8b7c83eeafbd9a97bec3a579c3d26edf11b005",
- "sha256:d0afc6e7b64ef30d6dcde88830ec1a237b9f16a39f920a8fd159928684ccf8db",
- "sha256:d4e263fa9428704fd94c2cb565c7519ca1d225217943f71caffe6741ab5b9df1",
- "sha256:e923c105100ab70abde1c01d3196ddd6b07255e32073685542be4e3a60870c8e",
- "sha256:ee386bec6d62f8c814d65c011d604a7c82d24aa3f718facd66e850eea8d6a5a1",
- "sha256:f15673e97f0a68b4c378c4d15b088fe96d60bc106d278c88829923118833c20f",
- "sha256:f7a1fcdbafaacac0530da04edca4a44303baab430ea42e7d59aece4b3f3e9a51"
- ],
- "version": "==1.1.1"
- },
- "requests": {
- "hashes": [
- "sha256:64299f4909223da747622c030b781c0d7811e359c37124b4bd368fb8c6518baa",
- "sha256:98b1b2782e3c6c4904938b84c0eb932721069dfdb9134313beff7c83c2df24bf"
- ],
- "markers": "python_version >= '3.7' and python_version < '4'",
- "version": "==2.28.2"
- },
- "rjsmin": {
- "hashes": [
- "sha256:113132a40ce7d03b2ced4fac215f0297338ed1c207394b739266efab7831988b",
- "sha256:122aa52bcf7ad9f12728d309012d1308c6ecfe4d6b09ea867a110dcad7b7728c",
- "sha256:145c6af8df42d8af102d0d39a6de2e5fa66aef9e38947cfb9d65377d1b9940b2",
- "sha256:1f982be8e011438777a94307279b40134a3935fc0f079312ee299725b8af5411",
- "sha256:3453ee6d5e7a2723ec45c2909e2382371783400e8d51952b692884c6d850a3d0",
- "sha256:35827844d2085bd59d34214dfba6f1fc42a215c455887437b07dbf9c73019cc1",
- "sha256:35f21046504544e2941e04190ce24161255479133751550e36ddb3f4af0ecdca",
- "sha256:5d67ec09da46a492186e35cabca02a0d092eda5ef5b408a419b99ee4acf28d5c",
- "sha256:747bc9d3bc8a220f40858e6aad50b2ae2eb7f69c924d4fa3803b81be1c1ddd02",
- "sha256:7dd58b5ed88233bc61dc80b0ed87b93a1786031d9977c70d335221ef1ac5581a",
- "sha256:812af25c08d6a5ae98019a2e1b47ebb47f7469abd351670c353d619eaeae4064",
- "sha256:8a6710e358c661dcdcfd027e67de3afd72a6af4c88101dcf110de39e9bbded39",
- "sha256:8c340e251619c97571a5ade20f147f1f7e8664f66a2d6d7319e05e3ef6a4423c",
- "sha256:99c074cd6a8302ff47118a9c3d086f89328dc8e5c4b105aa1f348fb85c765a30",
- "sha256:b8464629a18fe69f70677854c93a3707976024b226a0ce62707c618f923e1346",
- "sha256:bbd7a0abaa394afd951f5d4e05249d306fec1c9674bfee179787674dddd0bdb7",
- "sha256:bc5bc2f94e59bc81562c572b7f1bdd6bcec4f61168dc68a2993bad2d355b6e19",
- "sha256:bd1faedc425006d9e86b23837d164f01d105b7a8b66b767a9766d0014773db2a",
- "sha256:ca90630b84fe94bb07739c3e3793e87d30c6ee450dde08653121f0d9153c8d0d",
- "sha256:d332e44a1b21ad63401cc7eebc81157e3d982d5fb503bb4faaea5028068d71e9",
- "sha256:eb770aaf637919b0011c4eb87b9ac6317079fb9800eb17c90dda05fc9de4ebc3",
- "sha256:f0895b360dccf7e2d6af8762a52985e3fbaa56778de1bf6b20dbc96134253807",
- "sha256:f7cd33602ec0f393a0058e883284496bb4dbbdd34e0bbe23b594c8933ddf9b65"
- ],
- "version": "==1.2.1"
- },
- "soupsieve": {
- "hashes": [
- "sha256:49e5368c2cda80ee7e84da9dbe3e110b70a4575f196efb74e51b94549d921955",
- "sha256:e28dba9ca6c7c00173e34e4ba57448f0688bb681b7c5e8bf4971daafc093d69a"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==2.4"
- },
- "typing-extensions": {
- "hashes": [
- "sha256:5cb5f4a79139d699607b3ef622a1dedafa84e115ab0024e0d9c044a9479ca7cb",
- "sha256:fb33085c39dd998ac16d1431ebc293a8b3eedd00fd4a32de0ff79002c19511b4"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==4.5.0"
- },
- "typing-inspect": {
- "hashes": [
- "sha256:5fbf9c1e65d4fa01e701fe12a5bca6c6e08a4ffd5bc60bfac028253a447c5188",
- "sha256:8b1ff0c400943b6145df8119c41c244ca8207f1f10c9c057aeed1560e4806e3d"
- ],
- "version": "==0.8.0"
- },
- "urllib3": {
- "hashes": [
- "sha256:8a388717b9476f934a21484e8c8e61875ab60644d29b9b39e11e4b9dc1c6b305",
- "sha256:aa751d169e23c7479ce47a0cb0da579e3ede798f994f5816a74e4f4500dcea42"
- ],
- "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'",
- "version": "==1.26.15"
- },
- "xmlschema": {
- "hashes": [
- "sha256:0caa96668807b4b51c42a0fe2b6610752bc59f069615df3e34dcfffb962973fd",
- "sha256:557f3632b54b6ff10576736bba62e43db84eb60f6465a83818576cd9ffcc1799"
- ],
- "markers": "python_version >= '3.7'",
- "version": "==2.2.2"
- }
- }
-}
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..adf7f493
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,179 @@
+# Astro Starter Kit: Docs Site
+
+```bash
+npm create astro@latest -- --template docs
+```
+
+[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/docs)
+[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/docs)
+[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/docs/devcontainer.json)
+
+> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+
+
+## Features
+
+- ✅ **Full Markdown support**
+- ✅ **Responsive mobile-friendly design**
+- ✅ **Sidebar navigation**
+- ✅ **Search (powered by Algolia)**
+- ✅ **Multi-language i18n**
+- ✅ **Automatic table of contents**
+- ✅ **Automatic list of contributors**
+- ✅ (and, best of all) **dark mode**
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
+
+To deploy your site to production, check out our [Deploy an Astro Website](https://docs.astro.build/guides/deploy) guide.
+
+## 👀 Want to learn more?
+
+Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+
+## Customize This Theme
+
+### Site metadata
+
+`src/consts.ts` contains several data objects that describe metadata about your site like title, description, default language, and Open Graph details. You can customize these to match your project.
+
+### CSS styling
+
+The theme's look and feel is controlled by a few key variables that you can customize yourself. You'll find them in the `src/styles/theme.css` CSS file.
+
+If you've never worked with CSS variables before, give [MDN's guide on CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) a quick read.
+
+This theme uses a "cool blue" accent color by default. To customize this for your project, change the `--theme-accent` variable to whatever color you'd like:
+
+```diff
+/* src/styles/theme.css */
+:root {
+ color-scheme: light;
+- --theme-accent: hsla(var(--color-blue), 1);
++ --theme-accent: hsla(var(--color-red), 1); /* or: hsla(#FF0000, 1); */
+```
+
+## Page metadata
+
+Astro uses frontmatter in Markdown pages to choose layouts and pass properties to those layouts. If you are using the default layout, you can customize the page in many different ways to optimize SEO and other things. For example, you can use the `title` and `description` properties to set the document title, meta title, meta description, and Open Graph description.
+
+```markdown
+---
+title: Example title
+description: Really cool docs example that uses Astro
+layout: ../../layouts/MainLayout.astro
+---
+
+# Page content...
+```
+
+For more SEO related properties, look at `src/components/HeadSEO.astro`
+
+### Sidebar navigation
+
+The sidebar navigation is controlled by the `SIDEBAR` variable in your `src/consts.ts` file. You can customize the sidebar by modifying this object. A default, starter navigation has already been created for you.
+
+```ts
+export const SIDEBAR = {
+ en: {
+ 'Section Header': [
+ { text: 'Introduction', link: 'en/introduction' },
+ { text: 'Page 2', link: 'en/page-2' },
+ { text: 'Page 3', link: 'en/page-3' },
+ ],
+ 'Another Section': [{ text: 'Page 4', link: 'en/page-4' }],
+ },
+};
+```
+
+Note the top-level `en` key: This is needed for multi-language support. You can change it to whatever language you'd like, or add new languages as you go. More details on this below.
+
+### Multiple Languages support
+
+The Astro docs template supports multiple languages out of the box. The default theme only shows `en` documentation, but you can enable multi-language support features by adding a second language to your project.
+
+To add a new language to your project, you'll want to extend the current `src/content/docs/[lang]/...` layout:
+
+```diff
+ 📂 src/content/docs
+ ┣ 📂 en
+ ┃ ┣ 📜 page-1.md
+ ┃ ┣ 📜 page-2.md
+ ┃ ┣ 📜 page-3.astro
++ ┣ 📂 es
++ ┃ ┣ 📜 page-1.md
++ ┃ ┣ 📜 page-2.md
++ ┃ ┣ 📜 page-3.astro
+```
+
+You'll also need to add the new language name to the `KNOWN_LANGUAGES` map in your `src/consts.ts` file. This will enable your new language switcher in the site header.
+
+```diff
+// src/consts.ts
+export const KNOWN_LANGUAGES = {
+ English: 'en',
++ Spanish: 'es',
+};
+```
+
+Last step: you'll need to add a new entry to your sidebar, to create the table of contents for that language. While duplicating every page might not sound ideal to everyone, this extra control allows you to create entirely custom content for every language.
+
+> Make sure the sidebar `link` value points to the correct language!
+
+```diff
+// src/consts.ts
+export const SIDEBAR = {
+ en: {
+ 'Section Header': [
+ { text: 'Introduction', link: 'en/introduction' },
+ // ...
+ ],
+ // ...
+ },,
++ es: {
++ 'Encabezado de sección': [
++ { text: 'Introducción', link: 'en/introduction' },
++ // ...
++ ],
++ // ...
++ },
+};
+
+// ...
+```
+
+If you plan to use Spanish as the default language, you just need to modify the redirect path in `src/pages/index.astro`:
+
+```diff
+
+```
+
+You can also remove the above script and write a landing page in Spanish instead.
+
+### What if I don't plan to support multiple languages?
+
+That's totally fine! Not all projects need (or can support) multiple languages. You can continue to use this theme without ever adding a second language.
+
+If that single language is not English, you can just replace `en` in directory layouts and configurations with the preferred language.
+
+### Search (Powered by Algolia)
+
+[Algolia](https://www.algolia.com/) offers a free service to qualified open source projects called [DocSearch](https://docsearch.algolia.com/). If you are accepted to the DocSearch program, provide your API Key & index name in `src/consts.ts` and a search box will automatically appear in your site header.
+
+Note that Algolia and Astro are not affiliated. We have no say over acceptance to the DocSearch program.
+
+If you'd prefer to remove Algolia's search and replace it with your own, check out the `src/components/Header.astro` component to see where the component is added.
diff --git a/docs/Setup.md b/docs/Setup.md
deleted file mode 100644
index c443f581..00000000
--- a/docs/Setup.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# Setup to build docs
-
-## Requirements
-- Python 3.10
-
-## Clone the repo
-Clone the entire repo and navigate to the docs folder
-```shell
-git clone https://github.com/xen-42/outer-wilds-new-horizons
-cd outer-wilds-new-horizons/docs
-```
-
-## Setup Pipenv
-Install pipenv if you haven't already
-```shell
-pip install --user pipenv
-```
-Install dependencies
-```shell
-pipenv install --dev
-```
-
-## Environment Variables
-- URL_PREFIX: Path to put before all links and static files, see below for recommended values
- - Production and Local Builds: "/"
- - PyCharm Development Server: "/outer-wilds-new-horizons/docs/out/"
-
-## Copy Schemas
-Create a folder called `schemas` in the `docs/content/pages/` folder and copy all schemas to generate into it, make sure not to add this folder to git.
-Production build automatically copies over schemas.
-
-## Generating
-Run `generate` with pipenv
-```shell
-pipenv run menagerie generate
-```
-
-## Opening
-- Production: Go to the site
-- Local: Go into `docs/out` in a new terminal window and run `py -m http.server 8080` and then connect to http://localhost:8080/
-- PyCharm Development Server: Right click `out/index.html` -> Open In -> Browser -> Default
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
new file mode 100644
index 00000000..764f8ec0
--- /dev/null
+++ b/docs/astro.config.mjs
@@ -0,0 +1,14 @@
+import { defineConfig } from 'astro/config';
+import preact from '@astrojs/preact';
+import react from '@astrojs/react';
+
+// https://astro.build/config
+export default defineConfig({
+ integrations: [
+ // Enable Preact to support Preact JSX components.
+ preact(),
+ // Enable React for the Algolia search component.
+ react(),
+ ],
+ site: `https://astro.build`,
+});
diff --git a/docs/config.json b/docs/config.json
deleted file mode 100644
index 3f15c8e4..00000000
--- a/docs/config.json
+++ /dev/null
@@ -1,72 +0,0 @@
-{
- "$schema": "https://raw.githubusercontent.com/Bwc9876/menagerie/master/menagerie/schemas/config_schema.json",
- "cache_enabled": false,
- "base_url": "https://nh.outerwildsmods.com/",
- "themes": {
- "bootstrap": "https://bootswatch.com/5/darkly/bootstrap.min.css",
- "highlight_js": "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/styles/github-dark-dimmed.min.css",
- "theme": "dark"
- },
- "styles": {
- "base": "styles/nh_base.css"
- },
- "search": {
- "enabled": false,
- "site": "nh.outerwildsmods.com"
- },
- "brand": {
- "app_name": "New Horizons",
- "favicon_folder": "fav/",
- "navbar_icon": "images/icon.webp",
- "navbar_icon_size": [
- 29,
- 29
- ],
- "socials": [
- {
- "name": "Discord",
- "link": "https://discord.gg/wusTQYbYTc",
- "icon": "discord"
- },
- {
- "name": "GitHub",
- "link": "https://github.com/xen-42/outer-wilds-new-horizons",
- "icon": "github"
- },
- {
- "name": "Patreon",
- "link": "https://patreon.com/ownh",
- "icon": "coin"
- }
- ],
- "meta": {
- "search_console_code": "SafYg2zgXPfpW4MZbkBTpAtuNs5W7N-upr08Kv6tyMo",
- "description": "Documentation on how to use the New Horizons planet creation tool for Outer Wilds.",
- "keywords": [
- "New Horizons",
- "Outer Wilds",
- "Modding",
- "C#",
- "Unity"
- ],
- "categories": [
- "games",
- "utilities"
- ],
- "image": "images/home/home_logo.webp",
- "image_alt": "The New Horizons Logo",
- "theme_color": "#ffab8a",
- "bg_color": "#1a1a1a"
- },
- "footer": {
- "show_made_with": false,
- "links": [
- {
- "link": "https://github.com/xen-42/outer-wilds-new-horizons/issues/new/choose",
- "text": "Report an issue",
- "external": true
- }
- ]
- }
- }
-}
diff --git a/docs/content/pages/404.md b/docs/content/pages/404.md
deleted file mode 100644
index 2d3034e9..00000000
--- a/docs/content/pages/404.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-Title: Page not Found
-Hide_In_Nav: True
-Render_TOC: False
----
-
-# Page Not Found
-
-The page you requested could not be found.
-
diff --git a/docs/content/pages/editor.md b/docs/content/pages/editor.md
deleted file mode 100644
index fd314789..00000000
--- a/docs/content/pages/editor.md
+++ /dev/null
@@ -1,65 +0,0 @@
----
-Title: Config Editor
-Sort_Priority: 50
----
-
-# Config Editor
-
-Are you tired of manually editing JSON? Do you want richer validation than a JSON schema? Well then the config editor may be for you!
-
-This page outlines how to install and use the config editor.
-
-## Installation
-
-To get started, head over to the [releases page for the editor](https://github.com/Outer-Wilds-New-Horizons/nh-config-editor/releases/latest) and install the file for your OS:
-
-- Windows: The .msi file (not the .msi.zip and .msi.zip.sig file)
-- MacOS: The .AppImage file (not the .AppImage.tar.gz or the .AppImage.tar.gz.sig file)
-
-Follow the installer instructions to complete setup
-
-## Creating a New Project
-
-Creating a new project is as simple as clicking the button.
-Fill out the form with thr info for your mod and a new project will be made at the specified path.
-
-## Editing Files
-
-To edit a file, navigate to it in the left panel and click on it.
-
-### JSON files
-
-JSON files (planets, systems, etc) have a graphical interface for editing, **this will clear comments!**
-
-If you don't want comments to be cleared, use the text editor
-
-#### Using the Text Editor
-
-Already familiar with JSON and prefer text-based editing? Simply open up settings (File -> Settings) and turn on the "Always use Text Editor" option.
-
-### Image and Audio Files
-
-You can view images and play audio files with this editor.
-
-### XML Files
-
-Right now, XML support is limited. You'll get syntax highlighting but no error checking or autofill.
-
-
-## Running the Game
-
-You can start the game from the editor by selecting Project -> Run Project this will open a new window where you can run the game
-
-### Log Port
-
-If you're using the mod manager and would like logs to appear there, you need to get the log port from the console, it's always the first entry in the logs. Keep in mind this port changes whenever you restart the manager.
-
-![Get the log port]({{ "images/editor/log_port.webp"|static }})
-
-
-## Building
-
-The editor also provides a system for building your mod to a zip file, which can then be uploaded to GitHub in a release. To do this, press Project -> Build (Release)
-
-
-
diff --git a/docs/content/pages/faq.jinja2 b/docs/content/pages/faq.jinja2
deleted file mode 100644
index 717f0d4a..00000000
--- a/docs/content/pages/faq.jinja2
+++ /dev/null
@@ -1,88 +0,0 @@
-{#~ Title:FAQ ~#}
-{#~ Sort_Priority:95 ~#}
-{#~ Render_TOC:False ~#}
-
-
-{% macro faq(id, q, a) %}
-
-
-
-
-
-
- {{ ("A: " + a)|simple_md|replace('
', '
')|safe }}
-
-
-
-{% endmacro %}
-
-
FAQ
-
-
- {{
- faq(
- "is-easy",
- "How easy is it to make a planet mod?",
- "Easy, you don't even need to know how to code! Just start off slowly and make a single planet with a few surface details. Don't try to make a full DLC-scale story mod on your first try."
- )
- }}
- {{
- faq(
- "model-whole-planet",
- "Can I model my entire planet in Blender and put it into the game?",
- "Yes! Follow the instructions on the Detailing page. All you have to do is add that model as a single detail prop at the center of the planet."
- )
- }}
- {{
- faq(
- "why-no-planet",
- "Why doesn't my planet show up in game?",
- "Have you checked the logs for errors? Are you using a program like [VSCode](https://code.visualstudio.com/){ target='_blank' } to write your configs that validates them against our schema to catch your errors? Do you incrementally test each new planet that you add, or did you write 10 json files and then try them all at once? If you're still not sure, come by our [Discord channel](https://discord.gg/wusTQYbYTc){ target='_blank' } (`#nh-addon-discussion`) and we'll try to help out!"
- )
- }}
- {{
- faq(
- "ui-program",
- "Will you make a UI program to generate json files in the future?",
- "Yes! It's available [on GitHub](https://github.com/Outer-Wilds-New-Horizons/nh-config-editor){ target='_blank' }."
- )
- }}
- {{
- faq(
- "when-version-1",
- "When will New Horizons get to version 1.0.0.",
- "It already did **BOZO**!!!!!"
- )
- }}
- {{
- faq(
- "feature-request",
- "When will (*insert feature request here*) be implemented into New Horizons?",
- "If it's on the road-map, eventually. If it's not on the road-map let us know and we'll see if it's something we can consider adding."
- )
- }}
- {{
- faq(
- "i-dont-use-reload-configs",
- "It takes so long to test my mod because I keep having to restart my game whenever I change something in a config.",
- "That's not a question. But go into your mod settings in game and enable Debug mode on New Horizons. Now there will be a “Reload Configs” button in your options screen that will reload all your planets without restarting your game!"
- )
- }}
- {{
- faq(
- "rails",
- "Will you ditch the physics simulation and instead track planet positions on their orbits as a function of time, effectively putting the planets on rails and thereby making the game more efficient and accurate at the expense of the game's original vision as being an actual simulation of orbital mechanics?",
- "**No.**"
- )
- }}
- {{
- faq(
- "jammer",
- "Will Jammer Be Added?",
- "Yes! Check **your front door**"
- )
- }}
-
+
+
diff --git a/docs/src/components/Schemas/Ref.astro b/docs/src/components/Schemas/Ref.astro
new file mode 100644
index 00000000..8acb72ef
--- /dev/null
+++ b/docs/src/components/Schemas/Ref.astro
@@ -0,0 +1,12 @@
+---
+import type { JSONSchema } from "@apidevtools/json-schema-ref-parser/dist/lib/types";
+
+export interface Props {
+ name: string;
+ parentSlug: string;
+}
+
+const { name, parentSlug } = Astro.props;
+---
+
+View {name}
diff --git a/docs/src/consts.ts b/docs/src/consts.ts
new file mode 100644
index 00000000..a23cc93d
--- /dev/null
+++ b/docs/src/consts.ts
@@ -0,0 +1,59 @@
+export const SITE = {
+ title: 'New Horizons',
+ description: 'Documentation on how to use the New Horizons planet creation tool for Outer Wilds.',
+ defaultLanguage: 'en-us',
+} as const;
+
+export const OPEN_GRAPH = {
+ image: {
+ src: 'https://nh.outerwildsmods.com/public/home_logo.webp',
+ alt:
+ 'The New Horizons Logo'
+ }
+};
+
+export const KNOWN_LANGUAGES = {
+ English: 'en',
+} as const;
+export const KNOWN_LANGUAGE_CODES = Object.values(KNOWN_LANGUAGES);
+
+export const GITHUB_EDIT_URL = `https://github.com/Outer-Wilds-New-Horizons/new-horizons/tree/main/docs`;
+
+export const COMMUNITY_INVITE_URL = `https://discord.gg/wusTQYbYTc`;
+
+// See "Algolia" section of the README for more information.
+export const ALGOLIA = {
+ indexName: 'XXXXXXXXXX',
+ appId: 'XXXXXXXXXX',
+ apiKey: 'XXXXXXXXXX',
+};
+
+export type Sidebar = Record<
+ (typeof KNOWN_LANGUAGE_CODES)[number],
+ Record
+>;
+export const SIDEBAR: Sidebar = {
+ en: {
+ 'Intro': [
+ { text: 'Introduction', link: 'en/introduction' },
+ ],
+ 'Guides': [
+ { text: 'Getting Started', link: 'en/getting-started' },
+ { text: 'Creating An Addon', link: 'en/creating-addons' },
+ { text: 'Updating Existing Planets', link: 'en/updating-planets' },
+ { text: 'Creating New Planets', link: 'en/planet-generation' },
+ { text: 'Detailing Planets', link: 'en/details' },
+ { text: 'Custom Star Systems', link: 'en/star-systems' },
+ { text: 'Adding Translations', link: 'en/translation' },
+ { text: 'Understanding XML', link: 'en/xml' },
+ { text: 'Ship Log', link: 'en/ship-log' },
+ { text: 'Dialogue', link: 'en/dialogue' },
+ { text: 'API', link: 'en/api' },
+ { text: 'Extending Configs', link: 'en/extending-configs' },
+ { text: 'Publishing Your Addon', link: 'en/publishing' },
+ ],
+ "Schemas": [
+ { text: "Celestial Body Schema", link: "schemas/body-schema" }
+ ]
+ },
+};
diff --git a/docs/src/content/config.ts b/docs/src/content/config.ts
new file mode 100644
index 00000000..2780035b
--- /dev/null
+++ b/docs/src/content/config.ts
@@ -0,0 +1,20 @@
+import { defineCollection, z } from 'astro:content';
+import { SITE } from '../consts';
+
+const docs = defineCollection({
+ schema: z.object({
+ title: z.string().default(SITE.title),
+ description: z.string().default(SITE.description),
+ lang: z.literal('en-us').default(SITE.defaultLanguage),
+ dir: z.union([z.literal('ltr'), z.literal('rtl')]).default('ltr'),
+ image: z
+ .object({
+ src: z.string(),
+ alt: z.string(),
+ })
+ .optional(),
+ ogLocale: z.string().optional(),
+ }),
+});
+
+export const collections = { docs };
diff --git a/docs/content/pages/tutorials/api.md b/docs/src/content/docs/en/api.md
similarity index 98%
rename from docs/content/pages/tutorials/api.md
rename to docs/src/content/docs/en/api.md
index ee84cab3..397db67a 100644
--- a/docs/content/pages/tutorials/api.md
+++ b/docs/src/content/docs/en/api.md
@@ -1,6 +1,6 @@
---
-Title: API
-Sort_Priority: 20
+title: API
+description: A guide on using New Horizons' API
---
## How to use the API
diff --git a/docs/content/pages/tutorials/creating_addon.md b/docs/src/content/docs/en/creating-addons.md
similarity index 88%
rename from docs/content/pages/tutorials/creating_addon.md
rename to docs/src/content/docs/en/creating-addons.md
index fc88919f..3609c398 100644
--- a/docs/content/pages/tutorials/creating_addon.md
+++ b/docs/src/content/docs/en/creating-addons.md
@@ -1,10 +1,8 @@
---
-Title: Creating An Addon
-Sort_Priority: 85
+title: Creating An Addon
+description: A guide to creating addons for New Horizons
---
-# Creating An Addon
-
Up until now, you've been using the sandbox feature of New Horizons (simply placing your files in the `xen.NewHorizons` folder).
While this is the easiest way to get started, you won't be able to publish your work like this. In this tutorial we will:
@@ -15,7 +13,7 @@ While this is the easiest way to get started, you won't be able to publish your
## Making a GitHub Repository
To get started, we need a place to store our code. GitHub is one of the most popular websites to store source code, and it's also what the mod database uses to let people access our mod.
-First you're going to want to [create a GitHub account](https://github.com/signup){ target="_blank" }, and then head to [this repository](https://github.com/xen-42/ow-new-horizons-config-template){ target="_blank" }.
+First you're going to want to [create a GitHub account](https://github.com/signup), and then head to [this repository](https://github.com/xen-42/ow-new-horizons-config-template).
Now, click the green "Use This Template" button.
- Set the Name to your username followed by a dot (`.`), followed by your mod's name in PascalCase (no spaces, new words have capital letters). So for example if my username was "Test" and my mod's name was "Really Cool Addon", I would name the repo `Test.ReallyCoolAddon`.
@@ -25,7 +23,7 @@ Now, click the green "Use This Template" button.
## Cloning the Repository
Now that we've created our GitHub repository (or "repo"), we need to clone (or download) it onto our computer.
-To do this we recommend using the [GitHub Desktop App](https://desktop.github.com/){ target="_blank" }, as it's much easier to use than having to fight with the command line.
+To do this we recommend using the [GitHub Desktop App](https://desktop.github.com/), as it's much easier to use than having to fight with the command line.
Once we open GitHub desktop we're going to log in, select File -> Options -> Accounts and sign in to your newly created GitHub account.
Now we're ready to clone the repo, select File -> Clone Repository. Your repository should appear in the list.
@@ -52,12 +50,12 @@ To get started editing the files, simply click "Open in Visual Studio Code" in G
- You can leave `version`, `owmlVersion`, and `dependencies` alone
- NewHorizonsConfig.dll: This is the heart of your addon, make sure to never move or rename it.
- README.md: This file is displayed on the mod website when you go to a specific mod's page, you can delete the current contents.
- - This file is a [markdown](https://www.markdowntutorial.com/){ target="_blank" } file, if you're not comfortable writing an entire README right now, just write a small description of your mod.
+ - This file is a [markdown](https://www.markdowntutorial.com/) file, if you're not comfortable writing an entire README right now, just write a small description of your mod.
### Committing The Changes
Now that we have our files set up, switch back to GitHub desktop, you'll notice that the files you've changed have appeared in a list on the left.
-What GitHub Desktop does is keep track of changes you make to your files over time.
+What GitHub Desktop does is keep track of changes you make to your files over time.
Then, once you're ready, you commit these changes to your repo by filling out the "Summary" field with a small description of your changes, and then pressing the blue button that says "commit to main".
Think of committing like taking a snapshot of your project at this moment in time. If you ever mess up your project, you can always revert to another commit to get back to a working version. It is highly recommended to commit often, there is no downside to committing too much.
@@ -76,8 +74,14 @@ You should see your mod there with the downloads counter set as a dash and the v
Now when you click "Start Game" and load into the solar system, you should be able to notice that the quantum moon is gone entirely, this means that your addon and its configs were successfully loaded.
+## Note About File Paths
+
+Whenever something refers to the "relative path" of a file, it means relative to your mod's directory, this means you **must** include the `planets` folder in the path:
+
+```json
+"planets/assets/images/MyCoolImage.png"
+```
+
## Going Forward
Now instead of using the New Horizons mod folder, you can use your own mod's folder instead.
-
-**Next Up: [Planet Generation]({{ "Planet Generation"|route }})**
diff --git a/docs/content/pages/tutorials/details.md b/docs/src/content/docs/en/details.md
similarity index 82%
rename from docs/content/pages/tutorials/details.md
rename to docs/src/content/docs/en/details.md
index 1c4c0cae..b304bd9a 100644
--- a/docs/content/pages/tutorials/details.md
+++ b/docs/src/content/docs/en/details.md
@@ -1,11 +1,9 @@
---
-Title: Detailing
-Sort_Priority: 80
+title: Detailing
+description: A guide to adding details to planets in New Horizons
---
-# Details/Scatterer
-
-For physical objects there are currently two ways of setting them up: specify an asset bundle and path to load a custom asset you created, or specify the path to the item you want to copy from the game in the scene hierarchy. Use the [Unity Explorer](https://outerwildsmods.com/mods/unityexplorer){ target="_blank" } mod to find an object you want to copy onto your new body. Some objects work better than others for this. Good luck. Some pointers:
+For physical objects there are currently two ways of setting them up: specify an asset bundle and path to load a custom asset you created, or specify the path to the item you want to copy from the game in the scene hierarchy. Use the [Unity Explorer](https://outerwildsmods.com/mods/unityexplorer) mod to find an object you want to copy onto your new body. Some objects work better than others for this. Good luck. Some pointers:
- Use "Object Explorer" to search
- Generally you can find planets by writing their name with no spaces/punctuation followed by "_Body".
@@ -22,20 +20,6 @@ The Prop Placer is a convenience tool that lets you manually place details from
1. This menu scrolls. If you do not see your mod, it may be further down the list.
3. The Prop Placer is now active! Unpause the game, and you can now place Nomai vases using "G"
-### How to Save
-
-1. In the Prop Placer Menu, you will see a greyed out button titled "Update your mod's configs".
-2. Click the small button to the left of it.
-3. Click "Update your mod's configs" to save!
-
-!!! alert-danger "IMPORTANT"
- Your updated configs will save *only* to your mod's build folder, eg "AppData\Roaming\OuterWildsModManager\OWML\Mods\you.yourModName"
-
-!!! alert-warning "WARNING"
- Dying in-game will cause you to lose all work since you last saved. Make sure to save often.
-
-What's that? You want to place something other than just vases? Well I can't say I agree with your choices, but here's how you would do that.
-
### How to Select Props
1. Pause the game again. The prop placer menu should still be visible.
@@ -56,13 +40,13 @@ What's that? You want to place something other than just vases? Well I can't say
## Asset Bundles
-Here is a template project: [Outer Wilds Unity Template](https://github.com/xen-42/outer-wilds-unity-template){ target="_blank" }
+Here is a template project: [Outer Wilds Unity Template](https://github.com/xen-42/outer-wilds-unity-template)
The template project contains ripped versions of all the game scripts, meaning you can put things like DirectionalForceVolumes in your Unity project to have artificial gravity volumes loaded right into the game.
If for whatever reason you want to set up a Unity project manually instead of using the template, follow these instructions:
-1. Start up a Unity 2017 project (I use Unity 2017.4.40f1 (64-bit), so if you use something else I can't guarantee it will work). The DLC updated Outer Wilds to 2019.4.27 so that probably works, but I personally haven't tried it.
+1. Start up a Unity 2019.4.39f1 project
2. In the "Assets" folder in Unity, create a new folder called "Editor". In it create a file called "CreateAssetBundle.cs" with the following code in it:
```cs
@@ -87,10 +71,11 @@ public class CreateAssetBundles
3. Create your object in the Unity scene and save it as a prefab.
4. Add all files used (models, prefabs, textures, materials, etc.) to an asset bundle by selecting them and using the dropdown in the bottom right. Here I am adding a rover model to my "rss" asset bundle for the Real Solar System add-on.
-
-5. In the top left click the "Assets" drop-down and select "Build AssetBundles". This should create your asset bundle in a folder in the root directory called "StreamingAssets".
-6. Copy the asset bundle and asset bundle .manifest files from StreamingAssets into your mod's "planets" folder. If you did everything properly they should work in game. To double-check everything is included, open the .manifest file in a text editor to see the files included and their paths.
+
+
+1. In the top left click the "Assets" drop-down and select "Build AssetBundles". This should create your asset bundle in a folder in the root directory called "StreamingAssets".
+2. Copy the asset bundle and asset bundle .manifest files from StreamingAssets into your mod's "planets" folder. If you did everything properly they should work in game. To double-check everything is included, open the .manifest file in a text editor to see the files included and their paths.
## Importing a planet's surface from Unity
diff --git a/docs/content/pages/tutorials/dialogue.md b/docs/src/content/docs/en/dialogue.md
similarity index 90%
rename from docs/content/pages/tutorials/dialogue.md
rename to docs/src/content/docs/en/dialogue.md
index bd44c160..b14e4c81 100644
--- a/docs/content/pages/tutorials/dialogue.md
+++ b/docs/src/content/docs/en/dialogue.md
@@ -1,14 +1,11 @@
---
-Title: Dialogue
-Description: Guide to making dialogue in New Horizons
-Sort_Priority: 30
+title: Dialogue
+description: Guide to making dialogue in New Horizons
---
-# Dialogue
-
This page goes over how to use dialogue in New Horizons.
-You may want to view [Understanding XML]({{ "Understanding XML"|route }}) if you haven't already.
+You may want to view [Understanding XML](/en/xml) if you haven't already.
## Understanding Dialogue
@@ -134,7 +131,7 @@ To use the dialogue XML you have created, you simply need to reference it in the
## Dialogue Config
-To view the options for the dialogue prop, check [the schema]({{ "Celestial Body Schema"|route }}#Props_dialogue)
+To view the options for the dialogue prop, check [the schema](/schemas/body-schema#Props_dialogue)
## Controlling Conditions
@@ -151,7 +148,7 @@ You can set condition in dialogue with the `` and `` in the `` tag instead of a `
+First thing you should specify about your planet is its orbit. `primaryBody` will specify what planet this body will orbit. If you're in a new solar system and want this planet to be the center, set `centerOfSolarSystem` to `true` (keep in mind `centerOfSolarSystem` is in the `Base` module, not `Orbit`). Next up you'll need to specify the [orbital parameters](https://en.wikipedia.org/wiki/Orbital_elements).
## Heightmaps
-Heightmaps are a way to generate unique terrain on your planet. First you specify a maximum and minimum height, and then specify a [heightMap]({{ "Celestial Body Schema"|route }}#HeightMap_heightMap) image. The more white a section of that image is, the closer to `maxHeight` that part of the terrain will be. Finally, you specify a `textureMap` which is an image that gets applied to the terrain.
+Heightmaps are a way to generate unique terrain on your planet. First you specify a maximum and minimum height, and then specify a [heightMap](/schemas/body_schema#HeightMap_heightMap) image. The more white a section of that image is, the closer to `maxHeight` that part of the terrain will be. Finally, you specify a `textureMap` which is an image that gets applied to the terrain.
Here's an example heightmap of earth from the Real Solar System addon.
-![Earth's Heightmap]({{ "images/planet_gen/earth_heightmap.webp"|static }})
+
```json
{
@@ -31,7 +29,7 @@ Here's an example heightmap of earth from the Real Solar System addon.
}
```
-There are also tools to help generate these images for you such as [Textures For Planets](https://www.texturesforplanets.com/){ target="_blank" }.
+There are also tools to help generate these images for you such as [Textures For Planets](https://www.texturesforplanets.com/).
## Variable Size Modules
diff --git a/docs/content/pages/tutorials/publishing.md b/docs/src/content/docs/en/publishing.md
similarity index 87%
rename from docs/content/pages/tutorials/publishing.md
rename to docs/src/content/docs/en/publishing.md
index 661ab3b8..85aaa21a 100644
--- a/docs/content/pages/tutorials/publishing.md
+++ b/docs/src/content/docs/en/publishing.md
@@ -1,13 +1,10 @@
---
-Title: Publishing Addons
-Sort_Priority: 1
+title: Publishing Addons
---
-# Publishing Your Addon
-
This page goes over how to publish a release for your mod and submit your mod to the [outer wilds mod database](https://github.com/ow-mods/ow-mod-db) for review.
-This guide assumes you've created your addon by following [the addon creation guide]({{ "Creating An Addon"|route }}).
+This guide assumes you've created your addon by following [the addon creation guide](/en/creating-addons).
## Housekeeping
@@ -16,8 +13,7 @@ Before you release anything, you'll want to make sure:
- Your mod has a descriptive `README.md`. (This will be shown on the website)
- Your repo has the description field (click the cog in the right column on the "Code" tab) set. (this will be shown in the manager)
- There's no `config.json` in your addon. (Not super important, but good practice)
-- Your manifest has a valid name, author, and unique name.
-
+- Your manifest has a valid name, author, and unique name.
## Releasing
@@ -49,8 +45,4 @@ If you want to update your mod, you can simply bump the version number in `manif
To edit the release notes displayed in discord, enter them in the "Description" field before you commit in GitHub desktop. The most recent commits description is used for the release notes.
-**You don't need to create a new issue on the database to update your mod, it will be updated automatically after a few minutes**
-
-
-
-
+**You don't need to create a new issue on the database to update your mod, it will be updated automatically after a few minutes.**
diff --git a/docs/content/pages/tutorials/ship_log.md b/docs/src/content/docs/en/ship-log.md
similarity index 89%
rename from docs/content/pages/tutorials/ship_log.md
rename to docs/src/content/docs/en/ship-log.md
index 62deeac7..80b08e2c 100644
--- a/docs/content/pages/tutorials/ship_log.md
+++ b/docs/src/content/docs/en/ship-log.md
@@ -1,64 +1,63 @@
---
-Title: Ship Log
-Description: A guide to editing the ship log in New Horizons
-Sort_Priority: 40
+title: Ship Log
+description: A guide to editing the ship log in New Horizons
---
-# Intro
+## Intro
Welcome! this page outlines how to create a custom ship log.
-If you haven't already, you may want to take a look at [Understanding XML]({{ "Understanding XML"|route }}) to get a better idea of how XML works.
+If you haven't already, you may want to take a look at [Understanding XML](/en/xml) to get a better idea of how XML works.
-# Understanding Ship Logs
+## Understanding Ship Logs
First thing's first, I'll define some terminology regarding ship logs in the game, and how ship logs are structured.
-## Entries
+### Entries
An entry is a card you see in rumor mode, it represents a specific area or concept in the game, such as Timber Hearth's
village or the southern observatory on Brittle Hollow.
An entry is split up into facts, a fact can either be a rumor fact or an explore fact.
-![entryExample]({{ "images/ship_log/entry_example.webp"|static }})
+
*In red you can see an entry, in green you can see the entry's facts*
-### Curiosities
+#### Curiosities
Curiosities are entries that represent big ideas in the story, such as the ATP or the OPC.
Non-curiosity entries have a Curiosity attribute that can be set to make the color of that entry match the color of the
curiosity (Like how everything regarding the Vessel is red)
-![curiosityExample]({{ "images/ship_log/curiosity_example.webp"|static }})
+
*The Ash Twin Project is an example of a curiosity (internally it's called TIME_LOOP)*
-### Child Entries
+#### Child Entries
Entries can be children of other entries, meaning they'll be smaller.
-![childEntryExample]({{ "images/ship_log/child_entry_example.webp"|static }})
+
*The murals at the old settlement on Brittle Hollow are examples of child entries*
-## Rumor Facts
+### Rumor Facts
A rumor fact represents the information you might hear about a specific area or concept, usually, you get these through
dialogue or maybe by observing a faraway planet.
-![rumorFactExample]({{ "images/ship_log/rumor_example.webp"|static }})
+
-## Explore Facts
+### Explore Facts
Explore facts represent the information you learn about a specific area or concept.
-![exploreFactExample]({{ "images/ship_log/explore_example.webp"|static }})
+
-# The XML
+## The XML
Now that we know some terminology, let's get into how the XML works.
Every planet in the ship log is represented by a single XML file, you can see this if you use the unity explorer mod and
navigate to ShipLogManager.
-## Example File
+### Example File
```xml
@@ -136,15 +135,15 @@ navigate to ShipLogManager.
```
-## Using The Schema
+### Using The Schema
In the example XML, you may notice something like `xsi:noNamespaceSchemaLocation` at the top, this tells whatever editor
you're using that the file at that link is the schema. The game simply ignores this though, so it won't be able to catch
errors at runtime.
-Some editors may require you to [Trust](https://code.visualstudio.com/docs/editor/workspace-trust){ target="_blank" } the workspace to use
+Some editors may require you to [Trust](https://code.visualstudio.com/docs/editor/workspace-trust) the workspace to use
the schema file. Doing this varies per-editor, and you may also have to right-click the link and click download.
-## Loading The File
+### Loading The File
You can load your XML file to your planet by doing adding the following to your planet's config
@@ -156,9 +155,9 @@ You can load your XML file to your planet by doing adding the following to your
}
```
-# Rumor Mode Options
+## Rumor Mode Options
-## Entry Layout
+### Entry Layout
By default, entries in rumor mode are laid out by rows, where each row is one planet. This will not make for a perfect
layout, so you can use the `entryPositions` property in your star system config to change them
@@ -187,10 +186,10 @@ For example, if I want to change an entry with the ID of `EXAMPLE_ENTRY` and ano
To help with this, download the unity explorer mod and manually position entries, then simply use the dev tools to dump all the entries to a json string you can copy and paste into your config.
-![autoDetectiveMode]({{ "images/ship_log/auto_rumor_mode.webp"|static }})
+
*A set of entries laid out with auto mode*
-## Images
+### Images
Custom entry images are a bit different from other custom images, instead of pointing to each file for each entry, you
point to a folder:
@@ -209,7 +208,7 @@ for example, `EXAMPLE_ENTRY`'s file would be named `EXAMPLE_ENTRY.png`.
you set alternate sprites by making a file with the entry's ID and `_ALT` at the end, so `EXAMPLE_ENTRY`'s alt image
would be `EXAMPLE_ENTRY_ALT.png`.
-## Curiosity Colors
+### Curiosity Colors
Colors for each curiosity is given in a list, so if I wanted the curiosity `EXAMPLE_ENTRY` to have a color of blue:
@@ -238,28 +237,28 @@ Colors for each curiosity is given in a list, so if I wanted the curiosity `EXAM
}
```
-![curiosityColorChange]({{ "images/ship_log/change_color.webp"|static }})
+
*The curiosity's color is changed to blue*
-# Map Mode Options
+## Map Mode Options
-## Layout
+### Layout
Layout in map mode can be handled in two different ways, either manual or automatic, if you try to mix them you'll get
an error.
Also, adding planets to the vanilla solar system requires you to use manual layout.
-### Automatic Layout
+#### Automatic Layout
In automatic layout, each planet that orbits the center of the solar system is put in a row, then, each planet orbiting
those planets are put in a column, then, each planet orbiting *those* planets are put in a row for as many planets there
are. The order of each planet is determined by their semi-major axis, if two planets have the same semi-major axis then
they're sorted by order loaded in.
-![autoMapMode]({{ "images/ship_log/auto_map_mode.webp"|static }})
+
*An example system laid out with auto mode*
-#### Offset
+##### Offset
The `offset` option lets you adjust a planet's offset from the last planet.
@@ -276,12 +275,12 @@ The `offset` option lets you adjust a planet's offset from the last planet.
For example, this offsets example planet in map mode by -5 units.
-### Manual Layout
+#### Manual Layout
The manual layout is a lot more involved than automatic but offers much greater freedom.
Manual layout **requires** you to fill out both `manualPosition` and `manualNavigationPosition`
-#### Manual Position
+##### Manual Position
Setting the `manualPosition` option in the `mapMode` object sets its position (if manual position isn't set, it assumes
the planet is using automatic mode)
@@ -302,7 +301,7 @@ the planet is using automatic mode)
}
```
-#### Manual Navigation Position
+##### Manual Navigation Position
This setting tells Outer Wilds how to handle navigation for this object, the x and y values correlate to the row and
column of this planet. For example, the sun station is at navigationPosition (0, 1) as it is in the first column on the
@@ -329,33 +328,33 @@ second row (you can't select the sun, so it doesn't have a row or column). So, b
We say this planet is to the right of the sun station (putting in a position that is already occupied will override what
is in that position).
-![navigationIndices]({{ "images/ship_log/map_indices.webp"|static }})
+
-#### Overriding Vanilla Planets
+##### Overriding Vanilla Planets
You can also move vanilla planets by creating configs with their names and changing their manualPosition and
manualNavigationPosition
-### Settings for both layouts
+#### Settings for both layouts
These settings can be used for both type of layouts
-#### Sprites
+##### Sprites
-##### Reveal Sprite
+###### Reveal Sprite
A path to the sprite to show for when the planet is revealed
-##### Outline Sprite
+###### Outline Sprite
A path to an outline to show for when the planet is undiscovered
-#### Invisible When Hidden
+##### Invisible When Hidden
Settings `invisibleWhenHidden` to true makes the planet entirely invisible when not discovered instead of showing an
outline.
-#### Scale
+##### Scale
How much to scale this planet in the map mode screen (you may have to change offset to compensate)
@@ -372,11 +371,11 @@ How much to scale this planet in the map mode screen (you may have to change off
Shrinks the planet by one half
-#### Remove
+##### Remove
Don't include this planet in map mode at all, simply ignore it
-#### Details
+##### Details
Details are images that go on top of a planet in map mode, and changes states with the planet (like the sand funnel
between Ash Twin and Ember Twin)
@@ -409,11 +408,11 @@ between Ash Twin and Ember Twin)
As you can see, they have similar properties to planets, with the addition of rotation
-# Revealing Facts
+## Revealing Facts
Of course, having a custom ship log is neat and all, but what use is it if the player can't unlock it?
-## Initial Reveal
+### Initial Reveal
You can set facts to reveal as soon as the player enters the system by adding the `initialReveal` property
@@ -428,7 +427,7 @@ You can set facts to reveal as soon as the player enters the system by adding th
}
```
-## Signal Discovery
+### Signal Discovery
You can set a fact to reveal as soon as a signal is identified by editing the signal's `Reveals` attribute
@@ -448,7 +447,7 @@ You can set a fact to reveal as soon as a signal is identified by editing the si
}
```
-## Dialogue
+### Dialogue
You can set a fact to reveal in dialogue with the `` tag
@@ -469,50 +468,50 @@ You can set a fact to reveal in dialogue with the `` tag
```
-## Reveal Volumes
+### Reveal Volumes
Reveal volumes are triggers/colliders in the world that can unlock facts from a variety of actions.
Reveal volumes are specified in the `Props` module, its key is `reveal`.
-### Position
+#### Position
The position of the reveal volume, relative to this planet's center
-### Radius
+#### Radius
How big the collider is (use the collider visualizer mod for help)
-### Reveals
+#### Reveals
A list of facts this volume reveals
-### Reveal On
+#### Reveal On
Can be any of the following:
-#### Enter
+##### Enter
When the player or probe enters the trigger, reveal the facts
-#### Observe
+##### Observe
When the player observes the trigger, reveal the facts
-#### Snapshot
+##### Snapshot
When the player takes a picture of the trigger, reveal the facts
-### Max Distance
+#### Max Distance
Can only be used if `revealOn` is set to Observe or Snapshot, the max distance away the player can be and still be able
to trigger the reveal
-### Max Angle
+#### Max Angle
Can only be used if `revealOn` is set to Observe, the max angle the player can be looking away from the trigger to still
trigger the reveal
-### Example
+#### Example
```json
{
@@ -536,7 +535,7 @@ trigger the reveal
}
```
-# Setting Entry Locations
+## Setting Entry Locations
Entry locations are the "Mark On HUD" option you see when in map mode, this allows the player to go back to where they
were in the event of the big funny.
@@ -560,4 +559,4 @@ Adding an entry location is similar to adding a Reveal Volume:
}
```
-![entryLocationExample]({{ "images/ship_log/entry_position.webp"|static }})
+
diff --git a/docs/content/pages/tutorials/star_system.md b/docs/src/content/docs/en/star-systems.md
similarity index 55%
rename from docs/content/pages/tutorials/star_system.md
rename to docs/src/content/docs/en/star-systems.md
index aa3218de..17540641 100644
--- a/docs/content/pages/tutorials/star_system.md
+++ b/docs/src/content/docs/en/star-systems.md
@@ -1,11 +1,8 @@
---
-Title: Star Systems
-Description: A guide to editing a custom star system in New Horizons
-Sort_Priority: 65
+title: Star Systems
+description: A guide to creating a custom star system in New Horizons
---
-# Intro
-
Welcome! This page outlines how to edit a custom star system.
## Getting Started
@@ -18,32 +15,34 @@ A star system config file will look something like this:
```json
{
- "$schema": "https://raw.githubusercontent.com/Outer-Wilds-New-Horizons/new-horizons/main/NewHorizons/Schemas/star_system_schema.json",
- "travelAudio": "assets/Travel.mp3",
- "Vessel": {
- "coords": {
- "x": [ 4, 0, 3, 1 ],
- "y": [ 0, 5, 4 ],
- "z": [ 5, 4, 0, 3, 1 ]
- },
- "vesselPosition": {
- "x": 0,
- "y": 0,
- "z": 8000
- }
- }
+ "$schema": "https://raw.githubusercontent.com/Outer-Wilds-New-Horizons/new-horizons/main/NewHorizons/Schemas/star_system_schema.json",
+ "travelAudio": "assets/Travel.mp3",
+ "Vessel": {
+ "coords": {
+ "x": [ 4, 0, 3, 1 ],
+ "y": [ 0, 5, 4 ],
+ "z": [ 5, 4, 0, 3, 1 ]
+ },
+ "vesselPosition": {
+ "x": 0,
+ "y": 0,
+ "z": 8000
+ }
+ }
}
```
-To see all the different things you can put into a config file check out the [Star System Schema]({{ 'Star System Schema'|route}}).
+To see all the different things you can put into a config file check out the [Star System Schema](/schemas/star_system_schema).
## Vessel Coordinates
-You can warp to custom star systems via the Nomai vessel. Each coordinate has to be 2-6 points long.
+You can warp to custom star systems via the Nomai vessel. Each coordinate has to be 2-6 points long.
These are the points for each coordinate node. When making your unique coordinate you should only use each point once.
-![nomaiCoordinateIndexes]({{ "images/star_system/nomai_coordinate_indexes.webp"|static }})
+
+
### Hearthian Solar System Vessel Coordinates
You can use these coordinates to warp back to the hearthian solar system.
-![hearthianSolarSystemCoordinates]({{ "images/star_system/hearthian_solar_system_coordinates.webp"|static }})
\ No newline at end of file
+
+
diff --git a/docs/content/pages/tutorials/translation.md b/docs/src/content/docs/en/translation.md
similarity index 64%
rename from docs/content/pages/tutorials/translation.md
rename to docs/src/content/docs/en/translation.md
index c31d14c1..b7d6f838 100644
--- a/docs/content/pages/tutorials/translation.md
+++ b/docs/src/content/docs/en/translation.md
@@ -1,10 +1,8 @@
---
-Title: Translations
-Sort_Priority: 60
+title: Translations
+description: A guide to creating translations in New Horizons
---
-# Translations
-
There are 12 supported languages in Outer Wilds: english, spanish_la, german, french, italian, polish, portuguese_br, japanese, russian, chinese_simple, korean, and turkish.
All translations must go in a folder in the root directory called "translations".
@@ -33,9 +31,9 @@ Here's an example, for `russian.json`:
}
```
-# CLI Tool
+## CLI Tool
-Are you tired of manually translating JSON? Do you want an automatic translator? Well then the [nh-translation-helper](https://www.npmjs.com/package/nh-translation-helper){ target="_blank" } may be for you!
+Are you tired of manually translating JSON? Do you want an automatic translator? Well then the [nh-translation-helper](https://www.npmjs.com/package/nh-translation-helper) may be for you!
This tool has the following features:
@@ -44,14 +42,14 @@ This tool has the following features:
This section outlines how to install and use the nh-translation-helper.
-## Installation
+### Installation
-To get started, head over to the [repo for the tool](https://github.com/96-38/nh-translation-helper){ target="_blank" } and prepare the requirements:
+To get started, head over to the [repo for the tool](https://github.com/96-38/nh-translation-helper) and prepare the requirements:
-- Install [Node.js](https://nodejs.org/){ target="_blank" } >= 12.0.0
- - Install the LTS version.
-- Get [DeepL API](https://www.deepl.com/docs-api){ target="_blank" } Key (Free or Pro)
- - Sign up [here](https://www.deepl.com/pro#developer){ target="_blank" }
+- Install [Node.js](https://nodejs.org/) >= 12.0.0
+ - Install the LTS version.
+- Get [DeepL API](https://www.deepl.com/docs-api) Key (Free or Pro)
+ - Sign up [here](https://www.deepl.com/pro#developer)
When you are ready, execute the following command in a terminal or command prompt:
@@ -67,13 +65,13 @@ You can use the tool by executing the following command in a terminal or command
nh-translation-helper
```
-## Generating a english.json from XML
+### Generating a english.json from XML
Select `Generate english.json from XML files` and enter the path of your project folder.
You are done! a english.json has been generated in "*your_project_root*/translations/".
-## Translating english.json to another language
+### Translating english.json to another language
Select `Translate JSON (DeepL API key required)` and enter the path of your project folder. ( Note: **Not** the path to the "translations" folder. )
@@ -83,19 +81,19 @@ You are done! a translated json file has been generated in "*your_project_root*/
Please enter the DeepL API key for the first time only. The API key will be saved on your PC.
-## Note
+### Note
- Not supported extracting UIDictionary and AchievementTranslations
- - It is difficult to parse these automatically, and the number of words is small that it would be better to add them by MOD developers manually for better results.
- - Translating UIDictionary and AchievementTranslations is supported.
+ - It is difficult to parse these automatically, and the number of words is small that it would be better to add them by MOD developers manually for better results.
+ - Translating UIDictionary and AchievementTranslations is supported.
- Not supported translation into Korean
- - Translation is provided by the DeepL API, so it is not possible to translate into languages that are not supported by DeepL.
+ - Translation is provided by the DeepL API, so it is not possible to translate into languages that are not supported by DeepL.
- The generated translations are "**not**" perfect
- - It is a machine translation though DeepL. The translations on DeepL are known to be too casual or to abbreviate some sentences.
- - It will need to be manually corrected to make it a good translation. However, this tool allows you to prototype and is more efficient than starting from scratch. Also, the CDATA tag has been removed from the translated text and must be added manually.
+ - It is a machine translation though DeepL. The translations on DeepL are known to be too casual or to abbreviate some sentences.
+ - It will need to be manually corrected to make it a good translation. However, this tool allows you to prototype and is more efficient than starting from scratch. Also, the CDATA tag has been removed from the translated text and must be added manually.
- Parsing errors may occur when trying to translate manually created JSON files
- - In many cases, this is due to a specific comment in the JSON. Please remove the comments and try again.
- - Most comments are processed normally, but errors may occur if the comment contains special symbols or if the comment is located at the end of a JSON object.
+ - In many cases, this is due to a specific comment in the JSON. Please remove the comments and try again.
+ - Most comments are processed normally, but errors may occur if the comment contains special symbols or if the comment is located at the end of a JSON object.
diff --git a/docs/content/pages/tutorials/update_existing.md b/docs/src/content/docs/en/updating-planets.md
similarity index 61%
rename from docs/content/pages/tutorials/update_existing.md
rename to docs/src/content/docs/en/updating-planets.md
index 76d127db..a020722e 100644
--- a/docs/content/pages/tutorials/update_existing.md
+++ b/docs/src/content/docs/en/updating-planets.md
@@ -1,15 +1,14 @@
---
-Title: Update Planets
-Sort_Priority: 85
+title: Update Existing Planets
+description: A guide for updating base-game planets in New Horizons
---
-# Update Existing Planets
+Similar to new planets, make a config where "Name" is the name of the planet. The name should be able to just match their in-game english names, however if you encounter any issues with that here are the in-code names for planets that are guaranteed to work: `SUN`, `CAVE_TWIN` (Ember Twin), `TOWER_TWIN` (Ash Twin), `TIMBER_HEARTH`, `BRITTLE_HOLLOW`, `GIANTS_DEEP`, `DARK_BRAMBLE`, `COMET` (Interloper), `WHITE_HOLE`, `WHITE_HOLE_TARGET` (Whitehole station I believe), `QUANTUM_MOON`, `ORBITAL_PROBE_CANNON`, `TIMBER_MOON` (Attlerock), `VOLCANIC_MOON` (Hollow's Lantern), `DREAMWORLD`, `MapSatellite`, `RINGWORLD` (the Stranger).
-Similar to above, make a config where "Name" is the name of the planet. The name should be able to just match their in-game english names, however if you encounter any issues with that here are the in-code names for planets that are guaranteed to work: `SUN`, `CAVE_TWIN` (Ember Twin), `TOWER_TWIN` (Ash Twin), `TIMBER_HEARTH`, `BRITTLE_HOLLOW`, `GIANTS_DEEP`, `DARK_BRAMBLE`, `COMET` (Interloper), `WHITE_HOLE`, `WHITE_HOLE_TARGET` (Whitehole station I believe), `QUANTUM_MOON`, `ORBITAL_PROBE_CANNON`, `TIMBER_MOON` (Attlerock), `VOLCANIC_MOON` (Hollow's Lantern), `DREAMWORLD`, `MapSatellite`, `RINGWORLD` (the Stranger).
-
-Only some of the above modules are supported (currently) for existing planets. Things you cannot modify for existing planets include: heightmaps, procedural generation, gravity, or their orbits. You also can't make them into stars or binary focal points (but why would you want to, just delete them and replace them entirely). However, this still means there are many things you can do: completely change their atmospheres, give them rings, asteroid belts, comet tails, lava, water, prop details, or signals.
+Only some of the above modules are supported (currently) for existing planets. Things you cannot modify for existing planets include: heightmaps, procedural generation, gravity, or their orbits. You also can't make them into stars or binary focal points (but why would you want to, just delete them and replace them entirely). However, this still means there are many things you can do: completely change their atmospheres, give them rings, asteroid belts, comet tails, lava, water, prop details, or signals.
You can also delete parts of an existing planet. Here's part of an example config which would delete the rising sand from Ember Twin:
+
```json
{
"name": "Ember Twin",
@@ -24,10 +23,11 @@ In `childrenToDestroy` you list the relative paths for the children of the plane
## Destroy Existing Planets
You do this (but with the appropriate name) as its own config.
+
```json
{
- "name" : "Ember Twin",
- "destroy" : true
+ "name" : "Ember Twin",
+ "destroy" : true
}
```
diff --git a/docs/content/pages/tutorials/xml.md b/docs/src/content/docs/en/xml.md
similarity index 79%
rename from docs/content/pages/tutorials/xml.md
rename to docs/src/content/docs/en/xml.md
index 5c4db19e..a324729d 100644
--- a/docs/content/pages/tutorials/xml.md
+++ b/docs/src/content/docs/en/xml.md
@@ -1,10 +1,8 @@
---
-Title: Understanding XML
-Sort_Priority: 50
+title: Understanding XML
+description: A guide for understanding how to write XML for New Horizons
---
-# Understanding XML
-
XML is the other language New Horizons uses for content.
XML files are usually passed straight to the game's code instead of going through New Horizons.
@@ -14,9 +12,9 @@ XML is composed of tags, a tag can represent a section or attribute
```xml
- Jim
- 32
-
+ Jim
+ 32
+
```
@@ -28,9 +26,9 @@ This XML could be written in JSON as:
```json
{
- "name": "Jim",
- "age": 32,
- "isMarried": true
+ "name": "Jim",
+ "age": 32,
+ "isMarried": true
}
```
@@ -40,7 +38,7 @@ XML is a lot more descriptive, you can actually tell that the object is supposed
All XML files must have **one** top-level tag, this varies depending on what you're using it for (like how ship logs use a `` tag).
-## Schemas
+## Schemas
XML files can also have schemas, you specify them by adding attributes to the top-level tag:
@@ -49,15 +47,11 @@ XML files can also have schemas, you specify them by adding attributes to the to
```
-In order to get schema validation and autofill you'll need the [Redhat XML VSCode extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml){ target="_blank" }.
+In order to get schema validation and autofill you'll need the [Redhat XML VSCode extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml).
## Uses
XML is used for the following:
-- [Ship log Entries]({{ "Ship Log"|route }})
-- [Dialogue]({{ "Dialogue"|route }})
-- [Translatable Text](#)
-
-
-
+- [Ship log Entries](/en/ship-log)
+- [Dialogue](/en/dialogue)
diff --git a/docs/src/env.d.ts b/docs/src/env.d.ts
new file mode 100644
index 00000000..576fcce3
--- /dev/null
+++ b/docs/src/env.d.ts
@@ -0,0 +1,10 @@
+///
+///
+
+interface ImportMetaEnv {
+ readonly GITHUB_TOKEN: string | undefined;
+}
+
+interface ImportMeta {
+ readonly env: ImportMetaEnv;
+}
diff --git a/docs/src/languages.ts b/docs/src/languages.ts
new file mode 100644
index 00000000..935e5da8
--- /dev/null
+++ b/docs/src/languages.ts
@@ -0,0 +1,10 @@
+import { KNOWN_LANGUAGES, KNOWN_LANGUAGE_CODES } from './consts';
+export { KNOWN_LANGUAGES, KNOWN_LANGUAGE_CODES };
+
+export const langPathRegex = /\/([a-z]{2}-?[A-Z]{0,2})\//;
+
+export function getLanguageFromURL(pathname: string) {
+ const langCodeMatch = pathname.match(langPathRegex);
+ const langCode = langCodeMatch ? langCodeMatch[1] : 'en';
+ return langCode as (typeof KNOWN_LANGUAGE_CODES)[number];
+}
diff --git a/docs/src/layouts/MainLayout.astro b/docs/src/layouts/MainLayout.astro
new file mode 100644
index 00000000..5ad6453e
--- /dev/null
+++ b/docs/src/layouts/MainLayout.astro
@@ -0,0 +1,139 @@
+---
+import type { MarkdownHeading } from "astro";
+import type { CollectionEntry } from "astro:content";
+import HeadCommon from "../components/HeadCommon.astro";
+import HeadSEO from "../components/HeadSEO.astro";
+import Header from "../components/Header/Header.astro";
+import PageContent from "../components/PageContent/PageContent.astro";
+import LeftSidebar from "../components/LeftSidebar/LeftSidebar.astro";
+import RightSidebar from "../components/RightSidebar/RightSidebar.astro";
+import Footer from "../components/Footer/Footer.astro";
+import { GITHUB_EDIT_URL, SITE } from "../consts";
+
+type Props = CollectionEntry<"docs">["data"] & {
+ headings: MarkdownHeading[];
+};
+
+const { headings, ...data } = Astro.props;
+const canonicalURL = new URL(Astro.url.pathname, Astro.site);
+const currentPage = Astro.url.pathname;
+const currentFile = `src/content/docs${currentPage.replace(/\/$/, "")}.md`;
+const githubEditUrl = `${GITHUB_EDIT_URL}/${currentFile}`;
+---
+
+
+
+
+
+
+ {`${data.title} | ${SITE.title}`}
+
+
+
+
+
+
+
+
+
+
+ +
+ ))
+ }
+ 
diff --git a/docs/src/components/Header/Header.astro b/docs/src/components/Header/Header.astro
new file mode 100644
index 00000000..3f578480
--- /dev/null
+++ b/docs/src/components/Header/Header.astro
@@ -0,0 +1,149 @@
+---
+import { getLanguageFromURL, KNOWN_LANGUAGE_CODES } from '../../languages';
+import { SITE } from '../../consts';
+import AstroLogo from './AstroLogo.astro';
+import SkipToContent from './SkipToContent.astro';
+import SidebarToggle from './SidebarToggle';
+import LanguageSelect from './LanguageSelect';
+import Search from './Search';
+
+type Props = {
+ currentPage: string;
+};
+
+const { currentPage } = Astro.props;
+const lang = getLanguageFromURL(currentPage);
+---
+
+