mirror/jak-project
1
0
Fork 0
mirror of https://github.com/open-goal/jak-project synced 2026-07-09 23:01:56 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Overhaul and organize all of the existing documentation we have (#412)

Browse Source 
* docs: Overhaul and organize all of the existing documentation we have

* docs: Autoscroll to top when changing pages
This commit is contained in:
Tyler Wilding
2021-05-02 14:58:22 -04:00
committed by GitHub
parent 7cb04c6cd5
commit 928cb48dd4
20 changed files with 2626 additions and 2220 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-docs.html
+34 -2
View File
@@ -33,6 +33,9 @@
.search a {
color: #c5ccd4 !important;
}
.sidebar li > p {
color: #ffe301;
}
</style>
</head>
<body>
@@ -43,10 +46,11 @@
repo: "https://github.com/water111/jak-project",
basePath: "./markdown/",
loadSidebar: true,
subMaxLevel: 2,
subMaxLevel: 3,
logo: "./markdown/imgs/logo-text-colored.png",
notFoundPage: true,
auto2top: true,
search: "auto", // default
// complete configuration parameters
search: {
maxAge: 86400000, // Expiration time, the default one day
@@ -57,10 +61,38 @@
depth: 6,
hideOtherSidebarContent: false, // whether or not to hide other sidebar content
},
plugins: [
function(hook, vm) {
hook.beforeEach(function(html) {
if (/githubusercontent\.com/.test(vm.route.file)) {
url = vm.route.file
.replace('raw.githubusercontent.com', 'github.com')
.replace(/\/master/, '/blob/master');
} else {
url =
'https://github.com/water111/jak-project/blob/master/docs' +
vm.route.file;
}
var editHtml = '[:memo: Edit Document](' + url + ')\n';
return (
editHtml +
html
);
})
},
],
};
</script>
<!-- Docsify v4 -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="https://unpkg.com/docsify@4.12.1/lib/plugins/search.min.js"></script>
<script src="https://unpkg.com/docsify-copy-code@2"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-c.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-cpp.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-clojure.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-lisp.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-scheme.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-nasm.min.js"></script>
</body>
</html>