Skip to content

Commit fa1dd58

Browse files
committed
broken anchors
1 parent c064555 commit fa1dd58

5 files changed

Lines changed: 139 additions & 80 deletions

File tree

docs/troubleshooting/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Commonly asked questions about Velopack.
99
- **Can Velopack bootstrap new runtimes during updates?** <br/>
1010
Yes, this is fully supported. Before installing updates, Velopack will prompt the user to install any missing runtimes.
1111
- **How do I install the `vpk` tool? / I've installed the tool but it doesn't work**
12-
You need to install the [.NET 8 SDK or later](../packaging/runtime.mdx#supported-frameworks) for your platform, and then run `dotnet tool install -g vpk`.
12+
You need to install the [.NET 8 SDK or later](https://dotnet.microsoft.com/download) for your platform, and then run `dotnet tool install -g vpk`.
1313
It's recommended to use the same version of `vpk` as the Velopack package referenced in your application to ensure compatibility.
1414
Alternatively, you can run `vpk` without installing it globally using the [`dnx`](https://learn.microsoft.com/dotnet/core/tools/dotnet-tool-exec?WT.mc_id=DT-MVP-5003472) command: `dnx vpk --version 1.0.0` (replace `1.0.0` with your Velopack package version).
1515
If you get a message that it was installed successfully, but running it in your terminal results in a "binary/command not found" message, it's probably because your PATH is not set-up properly. For windows, `%USERPROFILE%\.dotnet\tools` should be on the PATH. For macos, [see this issue](https://github.com/dotnet/sdk/issues/9415). In general, dotnet should set these paths up for you, but that is what you should check if things are not working.

docusaurus.config.ts

Lines changed: 134 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,128 @@
1-
import { themes as prismThemes } from 'prism-react-renderer';
2-
import type { Config } from '@docusaurus/types';
3-
import type * as Preset from '@docusaurus/preset-classic';
1+
import { themes as prismThemes } from "prism-react-renderer";
2+
import type { Config } from "@docusaurus/types";
3+
import type * as Preset from "@docusaurus/preset-classic";
44

55
const config: Config = {
6-
title: 'Velopack',
7-
tagline: 'Installer and automatic update framework for cross-platform desktop applications',
8-
favicon: 'favicon/favicon.ico',
9-
url: 'https://docs.velopack.io/',
10-
baseUrl: '/',
6+
title: "Velopack",
7+
tagline:
8+
"Installer and automatic update framework for cross-platform desktop applications",
9+
favicon: "favicon/favicon.ico",
10+
url: "https://docs.velopack.io/",
11+
baseUrl: "/",
1112
trailingSlash: false,
12-
organizationName: 'velopack',
13-
projectName: 'velopack.docs',
14-
onBrokenLinks: 'throw',
13+
organizationName: "velopack",
14+
projectName: "velopack.docs",
15+
onBrokenLinks: "throw",
16+
onBrokenAnchors: "throw",
1517
i18n: {
16-
defaultLocale: 'en',
17-
locales: ['en', 'es'],
18+
defaultLocale: "en",
19+
locales: ["en", "es"],
1820
localeConfigs: {
19-
en: { label: 'English', htmlLang: 'en' },
20-
es: { label: 'Español', htmlLang: 'es' },
21+
en: { label: "English", htmlLang: "en" },
22+
es: { label: "Español", htmlLang: "es" },
2123
},
2224
},
2325
customFields: {
24-
flowBaseUrl: 'https://app.velopack.io',
26+
flowBaseUrl: "https://app.velopack.io",
2527
},
2628
themes: [
27-
['@easyops-cn/docusaurus-search-local', {
28-
hashed: true,
29-
indexBlog: false,
30-
docsRouteBasePath: '/',
31-
ignoreFiles: new RegExp(".*reference/.*"),
32-
language: ['en', 'es'],
33-
}],
34-
'@docusaurus/theme-mermaid'
29+
[
30+
"@easyops-cn/docusaurus-search-local",
31+
{
32+
hashed: true,
33+
indexBlog: false,
34+
docsRouteBasePath: "/",
35+
ignoreFiles: new RegExp(".*reference/.*"),
36+
language: ["en", "es"],
37+
},
38+
],
39+
"@docusaurus/theme-mermaid",
3540
],
3641
plugins: [
37-
['@docusaurus/plugin-client-redirects', {
38-
redirects: [
39-
{ from: '/packaging/rid', to: '/packaging/runtime' },
40-
{ from: '/troubleshooting/cli', to: '/reference/cli' },
41-
{ from: '/category/quick-start', to: '/category/getting-started' },
42-
],
43-
}],
42+
[
43+
"@docusaurus/plugin-client-redirects",
44+
{
45+
redirects: [
46+
{ from: "/packaging/rid", to: "/packaging/runtime" },
47+
{ from: "/troubleshooting/cli", to: "/reference/cli" },
48+
{ from: "/category/quick-start", to: "/category/getting-started" },
49+
],
50+
},
51+
],
4452
],
4553
headTags: [
4654
// Favicon
47-
{ tagName: 'link', attributes: { rel: 'shortcut icon', href: '/favicon/favicon.ico' } },
48-
{ tagName: 'link', attributes: { rel: 'apple-touch-icon', sizes: '180x180', href: '/favicon/apple-touch-icon.png' } },
49-
{ tagName: 'link', attributes: { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon/icon_32.png' } },
50-
{ tagName: 'link', attributes: { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon/icon_16.png' } },
51-
{ tagName: 'link', attributes: { rel: 'manifest', href: '/favicon/site.webmanifest' } },
52-
{ tagName: 'link', attributes: { rel: 'mask-icon', href: '/favicon/safari-pinned-tab.svg', color: '#edd323' } },
53-
{ tagName: 'meta', attributes: { name: 'msapplication-TileColor', content: '#000000' } },
54-
{ tagName: 'meta', attributes: { name: 'theme-color', content: '#ffffff' } },
55+
{
56+
tagName: "link",
57+
attributes: { rel: "shortcut icon", href: "/favicon/favicon.ico" },
58+
},
59+
{
60+
tagName: "link",
61+
attributes: {
62+
rel: "apple-touch-icon",
63+
sizes: "180x180",
64+
href: "/favicon/apple-touch-icon.png",
65+
},
66+
},
67+
{
68+
tagName: "link",
69+
attributes: {
70+
rel: "icon",
71+
type: "image/png",
72+
sizes: "32x32",
73+
href: "/favicon/icon_32.png",
74+
},
75+
},
76+
{
77+
tagName: "link",
78+
attributes: {
79+
rel: "icon",
80+
type: "image/png",
81+
sizes: "16x16",
82+
href: "/favicon/icon_16.png",
83+
},
84+
},
85+
{
86+
tagName: "link",
87+
attributes: { rel: "manifest", href: "/favicon/site.webmanifest" },
88+
},
89+
{
90+
tagName: "link",
91+
attributes: {
92+
rel: "mask-icon",
93+
href: "/favicon/safari-pinned-tab.svg",
94+
color: "#edd323",
95+
},
96+
},
97+
{
98+
tagName: "meta",
99+
attributes: { name: "msapplication-TileColor", content: "#000000" },
100+
},
101+
{
102+
tagName: "meta",
103+
attributes: { name: "theme-color", content: "#ffffff" },
104+
},
55105
],
56106
markdown: {
57-
format: 'detect',
107+
format: "detect",
58108
mermaid: true,
59109
hooks: {
60-
onBrokenMarkdownLinks: 'throw',
110+
onBrokenMarkdownLinks: "throw",
61111
},
62112
},
63113
presets: [
64114
[
65-
'classic',
115+
"classic",
66116
{
67117
docs: {
68-
sidebarPath: './sidebars.ts',
69-
routeBasePath: '/',
118+
sidebarPath: "./sidebars.ts",
119+
routeBasePath: "/",
70120
editUrl: ({ versionDocsDirPath, docPath, locale }) => {
71121
let match;
72122
if ((match = docPath.match(/reference\/.*/)) != null) {
73123
return undefined; // reference pages can't be edited
74124
}
75-
if (locale != 'en') {
125+
if (locale != "en") {
76126
return undefined;
77127
// return 'https://crowdin.com/project/velopack/invite?h=88bec14b5657f004fe5ba325090df5ba2031736';
78128
}
@@ -85,69 +135,69 @@ const config: Config = {
85135
showReadingTime: true,
86136
},
87137
theme: {
88-
customCss: './src/css/custom.css',
138+
customCss: "./src/css/custom.css",
89139
},
90140
gtag: {
91-
trackingID: 'G-YM5CQ7KMDT',
141+
trackingID: "G-YM5CQ7KMDT",
92142
anonymizeIP: true,
93-
}
143+
},
94144
} satisfies Preset.Options,
95145
],
96146
],
97147

98148
themeConfig: {
99-
image: 'logo/opengraph.png',
149+
image: "logo/opengraph.png",
100150
colorMode: {
101151
respectPrefersColorScheme: true,
102152
},
103153
navbar: {
104154
// title: 'Velopack',
105155
hideOnScroll: false,
106156
logo: {
107-
alt: 'Velopack Logo',
108-
src: 'logo/velopack-black.svg',
109-
srcDark: 'logo/velopack-white.svg',
157+
alt: "Velopack Logo",
158+
src: "logo/velopack-black.svg",
159+
srcDark: "logo/velopack-white.svg",
110160
},
111161
items: [
112162
{
113-
type: 'docSidebar',
114-
sidebarId: 'mainSidebar',
115-
position: 'left',
116-
label: 'Guides',
163+
type: "docSidebar",
164+
sidebarId: "mainSidebar",
165+
position: "left",
166+
label: "Guides",
117167
},
118168
{
119-
type: 'docSidebar',
120-
sidebarId: 'referenceSidebar',
121-
position: 'left',
122-
label: 'Reference',
169+
type: "docSidebar",
170+
sidebarId: "referenceSidebar",
171+
position: "left",
172+
label: "Reference",
123173
},
124174
{
125-
to: '/blog',
126-
label: 'Blog',
127-
position: 'left'
175+
to: "/blog",
176+
label: "Blog",
177+
position: "left",
128178
},
129179
{
130-
type: 'localeDropdown',
131-
position: 'right',
180+
type: "localeDropdown",
181+
position: "right",
132182
},
133183
{
134-
href: 'https://github.com/velopack/velopack',
135-
position: 'right',
136-
className: 'header-icon header-icon-github',
137-
'aria-label': 'GitHub repository',
184+
href: "https://github.com/velopack/velopack",
185+
position: "right",
186+
className: "header-icon header-icon-github",
187+
"aria-label": "GitHub repository",
138188
},
139189
{
140-
href: 'https://discord.gg/CjrCrNzd3F',
141-
position: 'right',
142-
className: 'header-icon header-icon-discord',
143-
'aria-label': 'Discord invite',
190+
href: "https://discord.gg/CjrCrNzd3F",
191+
position: "right",
192+
className: "header-icon header-icon-discord",
193+
"aria-label": "Discord invite",
144194
},
145195
],
146196
},
147197
docs: {
148198
sidebar: {
149199
autoCollapseCategories: true,
150-
}
200+
},
151201
},
152202
// footer: {
153203
// style: 'dark',
@@ -195,7 +245,16 @@ const config: Config = {
195245
// copyright: `Copyright © ${new Date().getFullYear()} Velopack Ltd.`,
196246
// },
197247
prism: {
198-
additionalLanguages: ['csharp', 'rust', 'cpp', 'batch', 'powershell', 'java', 'toml', 'json'],
248+
additionalLanguages: [
249+
"csharp",
250+
"rust",
251+
"cpp",
252+
"batch",
253+
"powershell",
254+
"java",
255+
"toml",
256+
"json",
257+
],
199258
theme: prismThemes.oneLight,
200259
darkTheme: prismThemes.nightOwl,
201260
},

i18n/es/docusaurus-plugin-content-docs/current/integrating/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,10 @@ Los deltas mantienen las descargas pequeñas, pero Velopack recurrirá a una des
108108
- Si el tamaño combinado de los deltas es mayor que el paquete completo, se descarga el paquete completo en su lugar.
109109
- Si no hay un paquete base local sobre el que aplicar los deltas, los deltas se deshabilitan. Dado que solo las instalaciones de Windows (instalador) incluyen un `.nupkg` completo, la primera actualización después de una instalación que no sea Windows es siempre una descarga completa.
110110

111-
#### Concurrencia y reanudación
111+
#### Concurrencia y reanudación {#concurrency--resuming}
112112
`DownloadUpdatesAsync` adquiere un bloqueo global por aplicación (un archivo `.velopack_lock` en el directorio de paquetes) para que solo se ejecute una operación de descarga/aplicación a la vez. Si ya hay otra operación en curso, lanza `AcquireLockFailedException`. Si el paquete completo ya existe en el disco, se omite la descarga, y las descargas en curso se escriben en archivos `.partial`.
113113

114-
### Aplicar actualizaciones
114+
### Aplicar actualizaciones {#apply-updates}
115115
Una vez que la actualización se ha descargado, tienes algunas opciones disponibles. Llamar a `ApplyUpdatesAndRestart` o `ApplyUpdatesAndExit` cerrará tu aplicación, instalará cualquier [requisito previo de bootstrap](../packaging/bootstrapping.mdx), instalará la actualización y luego opcionalmente reiniciará tu aplicación de inmediato.
116116

117117
Si no deseas cerrar tu aplicación de inmediato, puedes llamar a `WaitExitThenApplyUpdates` en su lugar, que iniciará Update.exe y esperará 60 segundos antes de continuar. Si tu aplicación no ha salido dentro de los 60 segundos, será terminada.

i18n/es/docusaurus-plugin-content-docs/current/packaging/installer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ El instalador de Windows extraerá la aplicación en `%LocalAppData%\{packId}`.
2222

2323
El directorio `current` será completamente reemplazado [durante las actualizaciones](../integrating/overview.mdx). Los demás archivos añadidos por Velopack (`Update.exe` y `sq.version`) son cruciales y son archivos necesarios para que Velopack pueda actualizar correctamente su aplicación.
2424

25-
### Instalador MSI de Windows
25+
### Instalador MSI de Windows {#windows-msi-installer}
2626
Además de `Setup.exe`, Velopack puede generar un instalador `.msi` usando WiX 5. El MSI proporciona integración completa con Windows Installer, incluida la compatibilidad con instalaciones por máquina en Archivos de programa, la implementación mediante directivas de grupo y las entradas estándar de Agregar o quitar programas.
2727

2828
Para habilitar la generación de MSI, añada el indicador `--msi` a su comando `vpk pack`. El MSI se construye junto con `Setup.exe` durante el empaquetado.

i18n/es/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Preguntas frecuentes sobre Velopack.
99
- **¿Puede Velopack instalar nuevos runtimes durante las actualizaciones?** <br/>
1010
Sí, esto es totalmente compatible. Antes de instalar las actualizaciones, Velopack solicitará al usuario que instale los runtimes que falten.
1111
- **¿Cómo instalo la herramienta `vpk`? / Instalé la herramienta pero no funciona**
12-
Necesitas instalar el [SDK de .NET 8 o posterior](../packaging/runtime.mdx#supported-frameworks) para tu plataforma, y luego ejecutar `dotnet tool install -g vpk`.
12+
Necesitas instalar el [SDK de .NET 8 o posterior](https://dotnet.microsoft.com/download) para tu plataforma, y luego ejecutar `dotnet tool install -g vpk`.
1313
Se recomienda usar la misma versión de `vpk` que el paquete de Velopack referenciado en tu aplicación para garantizar la compatibilidad.
1414
Alternativamente, puedes ejecutar `vpk` sin instalarlo globalmente usando el comando [`dnx`](https://learn.microsoft.com/dotnet/core/tools/dotnet-tool-exec?WT.mc_id=DT-MVP-5003472): `dnx vpk --version 1.0.0` (reemplaza `1.0.0` con la versión de tu paquete de Velopack).
1515
Si recibes un mensaje de que se instaló correctamente, pero al ejecutarlo en tu terminal aparece un mensaje de "binary/command not found", probablemente se deba a que tu PATH no está configurado correctamente. En Windows, `%USERPROFILE%\.dotnet\tools` debe estar en el PATH. En macOS, [consulta este problema](https://github.com/dotnet/sdk/issues/9415). En general, dotnet debería configurar estas rutas automáticamente, pero eso es lo que debes verificar si las cosas no funcionan.

0 commit comments

Comments
 (0)