diff --git a/README.md b/README.md index f846ff6f..0f99ad68 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ - - Velopack Logo + + Velopack Logo --- diff --git a/docs/.gitignore b/docfx/.gitignore similarity index 100% rename from docs/.gitignore rename to docfx/.gitignore diff --git a/docs/docfx.json b/docfx/docfx.json similarity index 86% rename from docs/docfx.json rename to docfx/docfx.json index a061a90a..cc789eb8 100644 --- a/docs/docfx.json +++ b/docfx/docfx.json @@ -26,7 +26,7 @@ "resource": [ { "files": [ - "artwork/**" + "images/**" ] } ], @@ -39,8 +39,9 @@ "globalMetadata": { "_appName": "Velopack", "_appTitle": "Velopack", - "_appFaviconPath": "artwork/velopack.ico", + "_appFaviconPath": "images/velopack.ico", "_enableSearch": true, + "_disableNextArticle": true, "pdf": false } } diff --git a/docs/pages/compiling.md b/docfx/docs/compiling.md similarity index 100% rename from docs/pages/compiling.md rename to docfx/docs/compiling.md diff --git a/docs/pages/distributing/overview.md b/docfx/docs/distributing/overview.md similarity index 100% rename from docs/pages/distributing/overview.md rename to docfx/docs/distributing/overview.md diff --git a/docs/pages/distributing/toc.yml b/docfx/docs/distributing/toc.yml similarity index 100% rename from docs/pages/distributing/toc.yml rename to docfx/docs/distributing/toc.yml diff --git a/docs/pages/getting-started/csharp.md b/docfx/docs/getting-started/csharp.md similarity index 100% rename from docs/pages/getting-started/csharp.md rename to docfx/docs/getting-started/csharp.md diff --git a/docs/pages/getting-started/toc.yml b/docfx/docs/getting-started/toc.yml similarity index 100% rename from docs/pages/getting-started/toc.yml rename to docfx/docs/getting-started/toc.yml diff --git a/docs/pages/migrating.md b/docfx/docs/migrating.md similarity index 98% rename from docs/pages/migrating.md rename to docfx/docs/migrating.md index c427d784..3f00f46f 100644 --- a/docs/pages/migrating.md +++ b/docfx/docs/migrating.md @@ -2,7 +2,7 @@ # 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: 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! \ No newline at end of file diff --git a/docs/pages/packaging/bootstrapping.md b/docfx/docs/packaging/bootstrapping.md similarity index 100% rename from docs/pages/packaging/bootstrapping.md rename to docfx/docs/packaging/bootstrapping.md diff --git a/docs/pages/packaging/channels.md b/docfx/docs/packaging/channels.md similarity index 100% rename from docs/pages/packaging/channels.md rename to docfx/docs/packaging/channels.md diff --git a/docs/pages/packaging/installer.md b/docfx/docs/packaging/installer.md similarity index 100% rename from docs/pages/packaging/installer.md rename to docfx/docs/packaging/installer.md diff --git a/docs/pages/packaging/overview.md b/docfx/docs/packaging/overview.md similarity index 100% rename from docs/pages/packaging/overview.md rename to docfx/docs/packaging/overview.md diff --git a/docs/pages/packaging/rid.md b/docfx/docs/packaging/rid.md similarity index 100% rename from docs/pages/packaging/rid.md rename to docfx/docs/packaging/rid.md diff --git a/docs/pages/packaging/signing.md b/docfx/docs/packaging/signing.md similarity index 99% rename from docs/pages/packaging/signing.md rename to docfx/docs/packaging/signing.md index 0876473e..aa695968 100644 --- a/docs/pages/packaging/signing.md +++ b/docfx/docs/packaging/signing.md @@ -44,7 +44,7 @@ Codesigning and Notarization is required before your application can be run by u ### 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. 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. ### Setting up a NotaryTool profile diff --git a/docs/pages/packaging/toc.yml b/docfx/docs/packaging/toc.yml similarity index 100% rename from docs/pages/packaging/toc.yml rename to docfx/docs/packaging/toc.yml diff --git a/docs/pages/toc.yml b/docfx/docs/toc.yml similarity index 100% rename from docs/pages/toc.yml rename to docfx/docs/toc.yml diff --git a/docs/pages/troubleshooting/cli.md b/docfx/docs/troubleshooting/cli.md similarity index 100% rename from docs/pages/troubleshooting/cli.md rename to docfx/docs/troubleshooting/cli.md diff --git a/docs/pages/troubleshooting/debugging.md b/docfx/docs/troubleshooting/debugging.md similarity index 98% rename from docs/pages/troubleshooting/debugging.md rename to docfx/docs/troubleshooting/debugging.md index 18ae51bd..d014cf1e 100644 --- a/docs/pages/troubleshooting/debugging.md +++ b/docfx/docs/troubleshooting/debugging.md @@ -27,10 +27,10 @@ class ConsoleLogger : ILogger 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. -### UpdateMac +### MacOS / Linux All logs will be sent to `/tmp/velopack.log`. ## Advanced Debugging diff --git a/docs/pages/troubleshooting/toc.yml b/docfx/docs/troubleshooting/toc.yml similarity index 100% rename from docs/pages/troubleshooting/toc.yml rename to docfx/docs/troubleshooting/toc.yml diff --git a/docs/pages/updating/overview.md b/docfx/docs/updating/overview.md similarity index 100% rename from docs/pages/updating/overview.md rename to docfx/docs/updating/overview.md diff --git a/docs/pages/updating/shortcuts.md b/docfx/docs/updating/shortcuts.md similarity index 100% rename from docs/pages/updating/shortcuts.md rename to docfx/docs/updating/shortcuts.md diff --git a/docs/pages/updating/toc.yml b/docfx/docs/updating/toc.yml similarity index 100% rename from docs/pages/updating/toc.yml rename to docfx/docs/updating/toc.yml diff --git a/docs/pages/welcome.md b/docfx/docs/welcome.md similarity index 100% rename from docs/pages/welcome.md rename to docfx/docs/welcome.md diff --git a/docfx/hello.html b/docfx/hello.html new file mode 100644 index 00000000..e69de29b diff --git a/docs/artwork/Velopack_200.png b/docfx/images/Velopack_200.png similarity index 100% rename from docs/artwork/Velopack_200.png rename to docfx/images/Velopack_200.png diff --git a/docs/artwork/apple_certificate_list.png b/docfx/images/apple_certificate_list.png similarity index 100% rename from docs/artwork/apple_certificate_list.png rename to docfx/images/apple_certificate_list.png diff --git a/docs/artwork/velopack-black.svg b/docfx/images/velopack-black.svg similarity index 100% rename from docs/artwork/velopack-black.svg rename to docfx/images/velopack-black.svg diff --git a/docs/artwork/velopack-white.svg b/docfx/images/velopack-white.svg similarity index 100% rename from docs/artwork/velopack-white.svg rename to docfx/images/velopack-white.svg diff --git a/docs/artwork/velopack.ico b/docfx/images/velopack.ico similarity index 100% rename from docs/artwork/velopack.ico rename to docfx/images/velopack.ico diff --git a/docfx/index.md b/docfx/index.md new file mode 100644 index 00000000..128644b2 --- /dev/null +++ b/docfx/index.md @@ -0,0 +1,7 @@ +--- +_layout: landing +--- + +# WIP + +You probably just want to visit [the documentation](docs/welcome.md). \ No newline at end of file diff --git a/docs/templates/velopack/layout/_master.tmpl b/docfx/templates/velopack/layout/_master.tmpl similarity index 100% rename from docs/templates/velopack/layout/_master.tmpl rename to docfx/templates/velopack/layout/_master.tmpl diff --git a/docs/templates/velopack/public/main.css b/docfx/templates/velopack/public/main.css similarity index 90% rename from docs/templates/velopack/public/main.css rename to docfx/templates/velopack/public/main.css index b4792254..5bab70f2 100644 --- a/docs/templates/velopack/public/main.css +++ b/docfx/templates/velopack/public/main.css @@ -5,14 +5,14 @@ #velopack-logo { width: 160px; height: 50px; - background-image: url(/artwork/velopack-black.svg); + 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(/artwork/velopack-white.svg); + background-image: url(/images/velopack-white.svg); } .toc > div { diff --git a/docs/templates/velopack/public/main.js b/docfx/templates/velopack/public/main.js similarity index 100% rename from docs/templates/velopack/public/main.js rename to docfx/templates/velopack/public/main.js diff --git a/docs/toc.yml b/docfx/toc.yml similarity index 71% rename from docs/toc.yml rename to docfx/toc.yml index b61d9139..061acc65 100644 --- a/docs/toc.yml +++ b/docfx/toc.yml @@ -1,4 +1,4 @@ - name: Docs - href: pages/ + href: docs/ - name: API href: api/ \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 726f3876..00000000 --- a/docs/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -_layout: landing ---- - -# WIP diff --git a/src/Velopack.Vpk/Velopack.Vpk.csproj b/src/Velopack.Vpk/Velopack.Vpk.csproj index d158c108..b019acb2 100644 --- a/src/Velopack.Vpk/Velopack.Vpk.csproj +++ b/src/Velopack.Vpk/Velopack.Vpk.csproj @@ -19,7 +19,7 @@ - + diff --git a/src/Velopack/Velopack.csproj b/src/Velopack/Velopack.csproj index 7276a6c3..e282a36a 100644 --- a/src/Velopack/Velopack.csproj +++ b/src/Velopack/Velopack.csproj @@ -22,7 +22,7 @@ - +