Remove the docfx template

This commit is contained in:
Caelan Sayler
2024-02-12 18:04:37 +00:00
parent b35fce9433
commit 379f99e743
10 changed files with 20 additions and 270 deletions

3
docfx/.gitignore vendored
View File

@@ -1,3 +1,4 @@
api/
sdk/
_site/
_site/
templates/

View File

@@ -1 +1,6 @@
If you've reached this page, you're probably [looking for the documentation](https://velopack.io/docs/).
## If you've reached this page, you're probably [looking for the Velopack documentation site](https://velopack.io/docs/).
If you want to build and run the documentation site yourself locally, you can do so:
- Install docfx (`dotnet tool install -g docfx`)
- Run the site with `docfx --serve`
- Navigate to `http://localhost:8080/docs`.

View File

@@ -40,7 +40,6 @@
"globalMetadata": {
"_appName": "Velopack",
"_appTitle": "Velopack",
"_appFaviconPath": "images/velopack.ico",
"_enableSearch": true,
"_disableNextArticle": true,
"pdf": false

View File

@@ -1,2 +0,0 @@
- name: C# .NET
href: csharp.md

View File

@@ -1,6 +1,4 @@
# Velopack Documentation
🚧🚧This documentation is still under construction.🚧🚧
Velopack is an installation and auto-update framework for cross-platform .NET applications. It's opinionated, extremely easy to use with zero config needed. With just one command you can be up and running with an installable application, and it's lightning fast for your users, too.
Be sure to check us out on [GitHub](https://github.com/velopack/velopack) and [join our Discord](https://discord.gg/CjrCrNzd3F) for any questions/support!

View File

@@ -1,9 +1,11 @@
- name: Get started
- name: Welcome
href: index.md
- name: Getting Started
href: getting-started/toc.yml
homepage: getting-started/csharp.md
- name: Quick - C# .NET
href: getting-started/csharp.md
- name: Sample Apps
items:
@@ -14,18 +16,22 @@
- name: C++ / MSVC / Win32
href: https://github.com/velopack/velopack/tree/master/examples/VeloCppWinSample
- name: 1. App Updating
- name: Essentials
- name: App Updating
href: updating/toc.yml
homepage: updating/overview.md
- name: 2. Packaging Releases
- name: Packaging Releases
href: packaging/toc.yml
homepage: packaging/overview.md
- name: 3. Distributing Releases
- name: Distributing Releases
href: distributing/toc.yml
homepage: distributing/overview.md
- name: Advanced
- name: Troubleshooting
href: troubleshooting/toc.yml
homepage: troubleshooting/debugging.md

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

View File

@@ -1,148 +0,0 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
{{!include(/^public/.*/)}}
{{!include(favicon.ico)}}
{{!include(logo.svg)}}
<!DOCTYPE html>
<html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
<head>
<meta charset="utf-8">
{{#redirect_url}}
<meta http-equiv="refresh" content="0;URL='{{redirect_url}}'">
{{/redirect_url}}
{{^redirect_url}}
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
{{#description}}<meta name="description" content="{{description}}">{{/description}}
<link rel="icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
<link rel="stylesheet" href="{{_rel}}public/docfx.min.css">
<link rel="stylesheet" href="{{_rel}}public/main.css">
<meta name="docfx:navrel" content="{{_navRel}}">
<meta name="docfx:tocrel" content="{{_tocRel}}">
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
{{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
{{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}}
{{#_disableTocFilter}}<meta name="docfx:disabletocfilter" content="true">{{/_disableTocFilter}}
{{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}}
<meta name="loc:inThisArticle" content="{{__global.inThisArticle}}">
<meta name="loc:searchResultsCount" content="{{__global.searchResultsCount}}">
<meta name="loc:searchNoResults" content="{{__global.searchNoResults}}">
<meta name="loc:tocFilter" content="{{__global.tocFilter}}">
<meta name="loc:nextArticle" content="{{__global.nextArticle}}">
<meta name="loc:prevArticle" content="{{__global.prevArticle}}">
<meta name="loc:themeLight" content="{{__global.themeLight}}">
<meta name="loc:themeDark" content="{{__global.themeDark}}">
<meta name="loc:themeAuto" content="{{__global.themeAuto}}">
<meta name="loc:changeTheme" content="{{__global.changeTheme}}">
<meta name="loc:copy" content="{{__global.copy}}">
<meta name="loc:downloadPdf" content="{{__global.downloadPdf}}">
{{/redirect_url}}
</head>
{{^redirect_url}}
<script type="module" src="./{{_rel}}public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
{{#_googleAnalyticsTagId}}
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', '{{_googleAnalyticsTagId}}');
</script>
{{/_googleAnalyticsTagId}}
<body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}{{/_appLogoUrl}}">
<div id="velopack-logo" />
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
{{#_enableSearch}}
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search">
</form>
{{/_enableSearch}}
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em"
type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas"
aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="{{uid}}">
{{!body}}
</article>
{{^_disableContribution}}
<div class="contribution d-print-none">
{{#sourceurl}}
<a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
{{/sourceurl}}
{{^sourceurl}}{{#docurl}}
<a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
{{/docurl}}{{/sourceurl}}
</div>
{{/_disableContribution}}
{{^_disableNextArticle}}
<div class="next-article d-print-none border-top" id="nextArticle"></div>
{{/_disableNextArticle}}
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
{{#_enableSearch}}
<div class="container-xxl search-results" id="search-results"></div>
{{/_enableSearch}}
<!--<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
{{{_appFooter}}}{{^_appFooter}}<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>{{/_appFooter}}
</div>
</div>
</footer>-->
</body>
{{/redirect_url}}
</html>

View File

@@ -1,95 +0,0 @@
[data-bs-theme='dark'] body {
background-color: #020617 !important;
--main-bg-color: #020617 !important;
--bs-body-bg: #020617 !important;
--bs-body-bg-rgb: 2, 6, 23;
--bs-border-color: #232F3F !important;
/* --bs-link-color: #FFD148 !important;
--bs-link-color-rgb: 255, 209, 72; */
}
form.filter {
margin: 4px;
}
.form-control:focus {
color: var(--bs-body-color);
background-color: var(--bs-body-bg);
border-color: #ffe494;
outline: 0;
box-shadow: 0 0 0 0.25rem rgba(255, 201, 40, 0.25);
}
#velopack-logo {
width: 160px;
height: 50px;
background-image: url(/images/velopack-black.svg);
background-repeat: no-repeat;
background-position-y: center;
background-size: contain;
}
[data-bs-theme='dark'] #velopack-logo {
background-image: url(/images/velopack-white.svg);
}
.toc>div {
padding-left: 16px;
}
.toc li {
font-weight: 500;
font-size: 15px;
}
.toc .expand-stub::before {
font-size: 1em;
font-weight: 900;
margin-top: 0.1em;
margin-left: -1.6em;
}
.link-secondary {
color: rgba(var(--bs-emphasis-color-rgb), var(--bs-link-opacity, .70)) !important;
margin-left: 16px;
-webkit-box-decoration-break: clone;
box-decoration-break: clone;
}
h1 {
border-bottom: solid 4px var(--bs-border-color);
margin-bottom: 24px;
padding-bottom: 8px;
}
h2 {
border-bottom: solid 2px var(--bs-border-color);
margin-bottom: 16px;
margin-top: 48px;
padding-bottom: 8px;
}
h3 {
margin-top: 36px;
font-size: 1.5rem;
}
h4 {
font-size: 1.25rem;
}
pre {
border-radius: 6px;
}
ul {
margin-bottom: 16px !important;
}
.navbar-nav {
margin-bottom: 0 !important;
}
header {
height: 70px !important;
}

View File

@@ -1,14 +0,0 @@
export default {
iconLinks: [
{
icon: 'github',
href: 'https://github.com/velopack/velopack',
title: 'GitHub'
},
{
icon: 'discord',
href: 'https://discord.gg/CjrCrNzd3F',
title: 'Discord'
}
]
}