rename 'pages' to 'docs'

This commit is contained in:
Caelan Sayler
2024-01-26 22:11:58 +00:00
parent 31e5346ec0
commit aca79c56be
38 changed files with 22 additions and 19 deletions

View File

@@ -1,6 +1,6 @@
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/artwork/velopack-white.svg"> <source media="(prefers-color-scheme: dark)" srcset="docfx/images/velopack-white.svg">
<img alt="Velopack Logo" src="docs/artwork/velopack-black.svg" width="400"> <img alt="Velopack Logo" src="docfx/images/velopack-black.svg" width="400">
</picture> </picture>
--- ---

View File

View File

@@ -26,7 +26,7 @@
"resource": [ "resource": [
{ {
"files": [ "files": [
"artwork/**" "images/**"
] ]
} }
], ],
@@ -39,8 +39,9 @@
"globalMetadata": { "globalMetadata": {
"_appName": "Velopack", "_appName": "Velopack",
"_appTitle": "Velopack", "_appTitle": "Velopack",
"_appFaviconPath": "artwork/velopack.ico", "_appFaviconPath": "images/velopack.ico",
"_enableSearch": true, "_enableSearch": true,
"_disableNextArticle": true,
"pdf": false "pdf": false
} }
} }

View File

@@ -2,7 +2,7 @@
# Migrating to Velopack # Migrating to Velopack
## Squirrel.Windows and Clowd.Squirrel ## From Squirrel
If you are using one of these packages in your application, migrating will be mostly automated. Here are the general steps needed: If you are using one of these packages in your application, migrating will be mostly automated. Here are the general steps needed:
1. Replace the `Squirrel.Windows` or `Clowd.Squirrel` nuget package with the latest [`Velopack NuGet Package`](https://www.nuget.org/packages/velopack). 1. Replace the `Squirrel.Windows` or `Clowd.Squirrel` nuget package with the latest [`Velopack NuGet Package`](https://www.nuget.org/packages/velopack).
@@ -63,5 +63,5 @@ If you are using one of these packages in your application, migrating will be mo
``` ```
## ClickOnce ## From ClickOnce
There is no guide or advice for migrating ClickOnce applications yet. If you would like to contribute one, please open an issue or PR! There is no guide or advice for migrating ClickOnce applications yet. If you would like to contribute one, please open an issue or PR!

View File

@@ -44,7 +44,7 @@ Codesigning and Notarization is required before your application can be run by u
### Creating code signing certificates ### Creating code signing certificates
1. First, you will need to create an account at https://developer.apple.com, pay the annual developer fee, and accept any license agreements. 1. First, you will need to create an account at https://developer.apple.com, pay the annual developer fee, and accept any license agreements.
0. Navigate to your certificates: https://developer.apple.com/account/resources/certificates 0. Navigate to your certificates: https://developer.apple.com/account/resources/certificates
0. Click the (+) icon to create new certificates. You need to create both a `Developer ID Installer` and a `Developer ID Application` certificate for distribution of Velopack apps outside the Mac App Store. ![apple certificate list](~/artwork/apple_certificate_list.png) 0. Click the (+) icon to create new certificates. You need to create both a `Developer ID Installer` and a `Developer ID Application` certificate for distribution of Velopack apps outside the Mac App Store. ![apple certificate list](~/images/apple_certificate_list.png)
0. Open both certificates by clicking on them, press Download, and then double click the ".cer" file to install it to your local keychain. 0. Open both certificates by clicking on them, press Download, and then double click the ".cer" file to install it to your local keychain.
### Setting up a NotaryTool profile ### Setting up a NotaryTool profile

View File

@@ -27,10 +27,10 @@ class ConsoleLogger : ILogger
new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger()); new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger());
``` ```
### Update.exe & Setup.exe ### Windows
Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default. Please see the [command line reference](cli.md) for a comprehensive list of arguments supported. Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default. Please see the [command line reference](cli.md) for a comprehensive list of arguments supported.
### UpdateMac ### MacOS / Linux
All logs will be sent to `/tmp/velopack.log`. All logs will be sent to `/tmp/velopack.log`.
## Advanced Debugging ## Advanced Debugging

0
docfx/hello.html Normal file
View File

View File

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

7
docfx/index.md Normal file
View File

@@ -0,0 +1,7 @@
---
_layout: landing
---
# WIP
You probably just want to visit [the documentation](docs/welcome.md).

View File

@@ -5,14 +5,14 @@
#velopack-logo { #velopack-logo {
width: 160px; width: 160px;
height: 50px; height: 50px;
background-image: url(/artwork/velopack-black.svg); background-image: url(/images/velopack-black.svg);
background-repeat: no-repeat; background-repeat: no-repeat;
background-position-y: center; background-position-y: center;
background-size: contain; background-size: contain;
} }
[data-bs-theme='dark'] #velopack-logo { [data-bs-theme='dark'] #velopack-logo {
background-image: url(/artwork/velopack-white.svg); background-image: url(/images/velopack-white.svg);
} }
.toc > div { .toc > div {

View File

@@ -1,4 +1,4 @@
- name: Docs - name: Docs
href: pages/ href: docs/
- name: API - name: API
href: api/ href: api/

View File

@@ -1,5 +0,0 @@
---
_layout: landing
---
# WIP

View File

@@ -19,7 +19,7 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<None Include="..\..\docs\artwork\Velopack_200.png" Pack="true" PackagePath="\" /> <None Include="..\..\docfx\images\Velopack_200.png" Pack="true" PackagePath="\" />
<None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" /> <None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" />
</ItemGroup> </ItemGroup>

View File

@@ -22,7 +22,7 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<None Include="..\..\docs\artwork\Velopack_200.png" Pack="true" PackagePath="\" /> <None Include="..\..\docfx\images\Velopack_200.png" Pack="true" PackagePath="\" />
<None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" /> <None Include="..\..\README_NUGET.md" Pack="true" PackagePath="\" />
</ItemGroup> </ItemGroup>