Update Docs (#148)

* Start on docs about page

* Move to home page

* Fix Clipboard Buttons
This commit is contained in:
Ben C 2022-05-20 20:07:04 -04:00 committed by GitHub
parent cf50de928a
commit bb7f7a7713
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 19 additions and 84 deletions

2
.gitignore vendored
View File

@ -411,7 +411,7 @@ NewHorizons/Properties/**
# Docs # Docs
docs/out/** docs/out/**
docs/content/schemas/** docs/content/schemas/**
docs/schemas/** docs/content/pages/[Ss]chemas/**
docs/.m_cache/** docs/.m_cache/**
# Unity project # Unity project

14
docs/Pipfile.lock generated
View File

@ -115,7 +115,7 @@
"sha256:030650ab4457556d09867d1b503619652dccf1c3ae118343663848faded97fc0", "sha256:030650ab4457556d09867d1b503619652dccf1c3ae118343663848faded97fc0",
"sha256:7ea6998e6c86c724c0693ec7379559b1b568309c3500e0d64ced56b31b778fa2" "sha256:7ea6998e6c86c724c0693ec7379559b1b568309c3500e0d64ced56b31b778fa2"
], ],
"markers": "python_version >= '3.7' and python_version < '4'", "markers": "python_version >= '3.7' and python_version < '4.0'",
"version": "==0.41.1" "version": "==0.41.1"
}, },
"jsonschema": { "jsonschema": {
@ -154,7 +154,7 @@
"sha256:412520c7b6bba540c2c2067d6be3a523ab885703bf6a81d93963f848b55dfb9a", "sha256:412520c7b6bba540c2c2067d6be3a523ab885703bf6a81d93963f848b55dfb9a",
"sha256:f344d4adfba5d1de821f7850b36e3507f583468a7eb47e6fa191765ed0b9c66b" "sha256:f344d4adfba5d1de821f7850b36e3507f583468a7eb47e6fa191765ed0b9c66b"
], ],
"markers": "python_version >= '3.5' and python_version < '4'", "markers": "python_version >= '3.5' and python_version < '4.0'",
"version": "==2.4.3" "version": "==2.4.3"
}, },
"markupsafe": { "markupsafe": {
@ -220,11 +220,11 @@
}, },
"menagerie-docs": { "menagerie-docs": {
"hashes": [ "hashes": [
"sha256:0a67b60c0c5a2828fa961b2201c82768b0a215b927540e63e8fc8ae651c9e6ac", "sha256:5f02204f4c8a6a3eee947ee4c91266159b567fd8e22d69be43531ef2e4a99f6a",
"sha256:fb84642030b107e2923509d2c811e0ec029bf37633c35b1e4eada182191b43e9" "sha256:ad69a97a65a73ad3f2be0f28638b74d1a6af68a5ce00c7b9726a9e0e89bb3d82"
], ],
"index": "pypi", "index": "pypi",
"version": "==0.1.6" "version": "==0.1.8"
}, },
"mypy-extensions": { "mypy-extensions": {
"hashes": [ "hashes": [
@ -238,7 +238,7 @@
"sha256:5053fc5ca7b8a281081274702ebf1584e341f40a68e6ab8f6b4b79f4b3fdf18e", "sha256:5053fc5ca7b8a281081274702ebf1584e341f40a68e6ab8f6b4b79f4b3fdf18e",
"sha256:8e8226f15c0b25565aa391797963b78c95930e12efc40e905153130783e766be" "sha256:8e8226f15c0b25565aa391797963b78c95930e12efc40e905153130783e766be"
], ],
"markers": "python_version >= '3.8' and python_version < '4'", "markers": "python_version >= '3.8' and python_version < '4.0'",
"version": "==0.1.0" "version": "==0.1.0"
}, },
"packaging": { "packaging": {
@ -477,7 +477,7 @@
"sha256:44ece4d53fb1706f667c9bd1c648f5469a2ec925fcf3a776667042d645472c14", "sha256:44ece4d53fb1706f667c9bd1c648f5469a2ec925fcf3a776667042d645472c14",
"sha256:aabaf16477806a5e1dd19aa41f8c2b7950dd3c746362d7e3223dbe6de6ac448e" "sha256:aabaf16477806a5e1dd19aa41f8c2b7950dd3c746362d7e3223dbe6de6ac448e"
], ],
"markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'", "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4.0'",
"version": "==1.26.9" "version": "==1.26.9"
}, },
"xmlschema": { "xmlschema": {

View File

@ -8,8 +8,7 @@
"theme": "dark" "theme": "dark"
}, },
"styles": { "styles": {
"base": "styles/base.css", "base": "styles/nh_base.css"
"schema": "styles/schema.css"
}, },
"search": { "search": {
"enabled": true, "enabled": true,

View File

@ -145,3 +145,13 @@ These tools/references are highly recommended
- [XML Basics Tutorial](https://www.w3schools.com/xml/xml_whatis.asp){ target="_blank" } - [XML Basics Tutorial](https://www.w3schools.com/xml/xml_whatis.asp){ target="_blank" }
- [JSON Basics Tutorial](https://www.tutorialspoint.com/json/index.htm){ target="_blank" } - [JSON Basics Tutorial](https://www.tutorialspoint.com/json/index.htm){ target="_blank" }
- [The Examples Mod](https://github.com/xen-42/ow-new-horizons-examples){ target="_blank" } - [The Examples Mod](https://github.com/xen-42/ow-new-horizons-examples){ target="_blank" }
## Disclaimer
This work is unofficial fan content created under permission from the [Mobius Digital Fan Content Policy](https://www.mobiusdigitalgames.com/fan-content-policy.html). It includes materials which are the property of Mobius Digital, and it is neither approved nor endorsed by Mobius Digital.
We are not responsible for any mods created using the New Horizons modding framework and assume no responsibility in the event an addon violates the terms.
## License
The license for this project is available [on the GitHub repository](https://github.com/xen-42/outer-wilds-new-horizons/blob/main/LICENSE).

View File

@ -1,55 +0,0 @@
$(document).on('click', 'a[href^="#"]', function (event) {
if (this.href.split("#")[1] === "top") return;
event.preventDefault();
history.pushState({}, '', this.href);
});
function flashElement(elementId) {
myElement = document.getElementById(elementId).parentNode;
myElement.classList.add("jsfh-animated-property");
setTimeout(function () {
myElement.classList.remove("jsfh-animated-property");
}, 1000);
}
function setAnchor(anchorLinkDestination) {
history.pushState({}, '', anchorLinkDestination);
}
function anchorOnLoad() {
let linkTarget = window.location.hash.split("?")[0].split("&")[0];
if (linkTarget[0] === "#") {
let idTarget = linkTarget.substring(1);
if (idTarget !== "top") {
anchorLink(idTarget);
}
}
}
function anchorLink(linkTarget) {
const target = $("#" + linkTarget);
target.parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(
function (index) {
if ($(this).hasClass("collapse")) {
$(this).collapse("show");
} else if ($(this).hasClass("tab-pane")) {
const tabToShow = $("a[href='#" + $(this).attr("id") + "']");
if (tabToShow) {
tabToShow.tab("show");
}
} else if ($(this).attr("role") === "tab") {
$(this).tab("show");
}
}
);
setTimeout(function () {
let targetElement = document.getElementById(linkTarget);
if (targetElement) {
targetElement.scrollIntoView({block: "center", behavior: "smooth"});
setTimeout(function () {
flashElement(linkTarget);
}, 500);
}
}, 1000);
}

View File

@ -1,19 +0,0 @@
.jsfh-animated-property {
animation: eclair;
animation-iteration-count: 1;
animation-fill-mode: forwards;
animation-duration: .75s;
}
@keyframes eclair {
0%, 100% {
transform: scale(1);
}
50% {
transform: scale(1.03);
}
}
.bg-warning {
color: #131313;
}