mirror of
https://github.com/asdf-vm/asdf.git
synced 2024-11-15 09:38:16 -07:00
57c5e9dbcb
# Summary This contains fixes and significant improvements to the documentation site. * fixes some routing issues due to erroneous docsify config * fixed links and layout of 404 pg * improved the language on the landing page as per #438 * propose a NEW_README.md tackling concerns with #438 and #422 * use docsify specific md to emphasise some text * add docsify-themeable plugin to improve loading experience and future proof for customisation * improve use of `asdf-vm` over `asdf` ## Other Information Included in this PR is a file `docs/NEW_README.md` which is my proposed README for this repo. The intention was to have all documentation in a single place, the site, and simplify the readme bringing the focus to explaining the tool rather than instructing users on how to use it. I will create a separate PR for the README, but in the meantime the landing page composes this new readme with the ballad.
98 lines
3.3 KiB
HTML
98 lines
3.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>asdf vm - An extendable version manager</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
|
<meta name="description" content="An extendable version manager" />
|
|
<meta
|
|
name="viewport"
|
|
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
|
|
/>
|
|
<!-- site theme -->
|
|
<link
|
|
rel="stylesheet"
|
|
href="https://unpkg.com/docsify-themeable@0/dist/css/theme-simple.css"
|
|
title="light"
|
|
/>
|
|
<!-- prismjs theme -->
|
|
<!-- <link rel="stylesheet" href="//unpkg.com/prismjs@1.15.0/themes/prism.css" /> -->
|
|
<!-- <link rel="stylesheet" href="//unpkg.com/prismjs@1.15.0/themes/prism-coy.css" /> -->
|
|
<!-- <link rel="stylesheet" href="//unpkg.com/prism-themes/themes/prism-ghcolors.css" /> -->
|
|
<!-- <link rel="stylesheet" href="//unpkg.com/prism-themes/themes/prism-atom-dark.css" /> -->
|
|
</head>
|
|
<body>
|
|
<div id="app"></div>
|
|
<!-- edit on github plugin must appear here -->
|
|
<script src="//unpkg.com/docsify-edit-on-github@1.0.1/index.js"></script>
|
|
<script>
|
|
window.$docsify = {
|
|
name: "asdf-vm",
|
|
repo: "https://github.com/asdf-vm/asdf",
|
|
el: "#app",
|
|
homepage: "homepage.md",
|
|
coverpage: true,
|
|
loadNavbar: true,
|
|
loadSidebar: true,
|
|
notFoundPage: true,
|
|
subMaxLevel: 2,
|
|
auto2top: true,
|
|
alias: {
|
|
".*?/plugins-all":
|
|
"https://raw.githubusercontent.com/asdf-vm/asdf-plugins/master/README.md",
|
|
".*?/changelog":
|
|
"https://raw.githubusercontent.com/asdf-vm/asdf/master/CHANGELOG.md",
|
|
},
|
|
markdown: {
|
|
smartypants: true,
|
|
},
|
|
themeColor: "#AA00D4",
|
|
formatUpdated: "{MM}/{DD} {HH}:{mm}",
|
|
tabs: {
|
|
theme: "material",
|
|
},
|
|
search: {
|
|
paths: "auto",
|
|
placeholder: {
|
|
"/": "Type to search",
|
|
},
|
|
noData: {
|
|
"/": "No Results",
|
|
},
|
|
},
|
|
plugins: [
|
|
EditOnGithubPlugin.create(
|
|
"https://github.com/asdf-vm/asdf/blob/master/docs/"
|
|
),
|
|
],
|
|
};
|
|
</script>
|
|
<!-- docsify core -->
|
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
|
<!-- docsify core plugins -->
|
|
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
|
|
<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
|
|
<script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
|
|
<!-- 3rd party plugins -->
|
|
<script src="//unpkg.com/docsify-themeable@0"></script>
|
|
<script src="//unpkg.com/docsify-copy-code@2"></script>
|
|
<script src="//unpkg.com/docsify-tabs@1"></script>
|
|
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
|
|
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
|
|
<style>
|
|
:root {
|
|
/* Reduce the font size */
|
|
--base-font-size: 14px;
|
|
|
|
/* Change the theme color hue */
|
|
--theme-color: #aa00d4;
|
|
|
|
/* generate new cover bg color each load */
|
|
--cover-background-color: ;
|
|
/* leave cover page title black */
|
|
--cover-heading-color: ;
|
|
}
|
|
</style>
|
|
</body>
|
|
</html>
|