kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 17:48:18 -07:00
Code Issues Packages Projects Releases Wiki Activity
90b1e5d816
asdf/docs/index.html

101 lines
3.6 KiB
HTML
Raw Normal View History

Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
<!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"
Significant documentation site improvements (#440) # 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.
2019-01-25 01:17:20 -07:00
href="https://unpkg.com/docsify-themeable@0/dist/css/theme-simple.css"
title="light"
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
/>
Significant documentation site improvements (#440) # 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.
2019-01-25 01:17:20 -07:00
<!-- 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" /> -->
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
</head>
<body>
Significant documentation site improvements (#440) # 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.
2019-01-25 01:17:20 -07:00
<div id="app"></div>
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
<!-- edit on github plugin must appear here -->
Use custom edit on github plugin. Fix #469
2019-03-24 07:30:53 -07:00
<script src="scripts/docsify-edit-on-github.js"></script>
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
<script>
window.$docsify = {
name: "asdf-vm",
Significant documentation site improvements (#440) # 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.
2019-01-25 01:17:20 -07:00
repo: "https://github.com/asdf-vm/asdf",
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
el: "#app",
coverpage: true,
loadNavbar: true,
loadSidebar: true,
Significant documentation site improvements (#440) # 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.
2019-01-25 01:17:20 -07:00
notFoundPage: true,
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
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(
Use custom edit on github plugin. Fix #469
2019-03-24 07:30:53 -07:00
"https://github.com/asdf-vm/asdf/blob/master/docs/", {
customURLs: {
"https://raw.githubusercontent.com/asdf-vm/asdf-plugins/master/README.md": "https://github.com/asdf-vm/asdf-plugins/edit/master/README.md",
"https://raw.githubusercontent.com/asdf-vm/asdf/master/CHANGELOG.md": "https://github.com/asdf-vm/asdf/edit/master/CHANGELOG.md"
}
})
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
],
};
</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 -->
Significant documentation site improvements (#440) # 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.
2019-01-25 01:17:20 -07:00
<script src="//unpkg.com/docsify-themeable@0"></script>
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
<script src="//unpkg.com/docsify-copy-code@2"></script>
<script src="//unpkg.com/docsify-tabs@1"></script>
Significant documentation site improvements (#440) # 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.
2019-01-25 01:17:20 -07:00
<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>
Documentation site (#422) * init docsify * add config & plugins to support required features * create cover page * add sidebar headings * add novel 404 page * add translation message to 404 * add navbar with translations dropdown * fix punctuation * add all-plugins section pulling from asdf-plugins repo readme * update sidebar with sections, better names & descriptions for contributors * add changelog. pulls from repo * add thanks page. credits, maintainers & link to contributors on github * add core documentation * rm old readme from docs/ folder this was copied here on docsify init * comment out some translation config ideally this will remain commented out serving as an example for any translation contributions * run prettier over markdown * add plugins-create section * add contributing sections to the docs * fix cover page get-started link * use the readme as the main homepage * update asdf version in docs with release script
2019-01-12 09:32:30 -07:00
</body>
</html>
Reference in New Issue Copy Permalink