Skip to content

Commit ed73c9c

Browse files
SidValSidVal
authored
Update quickstart.md
1 parent 5621eca commit ed73c9c

File tree

1 file changed

+71
-42
lines changed

1 file changed

+71
-42
lines changed

‎quickstart.md

Lines changed: 71 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,123 @@
1-
# Inicio Rápido
1+
# Inicio rápido
22

3-
Se recomienda instalar `docsify-cli` globalmente, lo que ayuda a inicializar y obtener una vista previa del sitio web localmente.
3+
Se recomienda instalar `docsify-cli` de forma global, lo que ayuda a inicializar y previsualizar el sitio web localmente.
44

55
```bash
66
npm i docsify-cli -g
77
```
88

9-
## Inicializar
9+
## Inicialización
1010

11-
Si desea escribir la documentación en el subdirectorio `./docs`, puede usar el comando `init`.
11+
Si deseas escribir la documentación en el subdirectorio `./docs`, puedes utilizar el comando `init`.
1212

1313
```bash
1414
docsify init ./docs
1515
```
1616

1717
## Escribir contenido
1818

19-
Después de que se complete `init`, puede ver la lista de archivos en el subdirectorio `./docs`.
19+
Después de completar la inicialización, podrás ver la lista de archivos en el subdirectorio `./docs`.
2020

21-
* `index.html` como el archivo de entrada
22-
* `README.md` como la página de inicio (la principal)
23-
* `.nojekyll` impide que las páginas de GitHub ignoren los archivos que comienzan con un guión bajo
21+
- `index.html` como archivo de entrada
22+
- `README.md` como página de inicio
23+
- `.nojekyll` evita que GitHub Pages ignore los archivos que comienzan con un guion bajo
2424

25-
Puede actualizar fácilmente la documentación en `./docs/README.md`, por supuesto puede agregar [más páginas](/es/more-pages.md).
25+
Puedes actualizar fácilmente la documentación en `./docs/README.md`, y, por supuesto, puedes agregar [más páginas](/es/more-pages.md).
2626

27-
## Vista previa de su sitio
27+
## Previsualiza tu sitio
2828

29-
Ejecute el servidor local con `docsify serve`. Puede obtener una vista previa de su sitio en su navegador `http://localhost:3000`.
29+
Ejecuta el servidor local con `docsify serve`. Puedes previsualizar tu sitio en tu navegador en `http://localhost:3000`.
3030

3131
```bash
3232
docsify serve docs
3333
```
3434

35-
?> Para más casos de uso de `docsify-cli`, dirígete a la [documentación de docsify-cli](https://github.com/QingWei-Li/docsify-cli).
35+
?> Para obtener más casos de uso de `docsify-cli`, consulta la [documentación de docsify-cli](https://github.com/docsifyjs/docsify-cli).
3636

3737
## Inicialización manual
3838

39-
Si no te gusta `npm` o tiene problemas para instalar la herramienta, puede crear manualmente `index.html`:
39+
Si no te gusta `npm` o tienes problemas para instalar la herramienta, puedes crear manualmente `index.html`:
4040

4141
```html
4242
<!-- index.html -->
4343

4444
<!DOCTYPE html>
4545
<html>
46-
<head>
47-
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
48-
<meta name="viewport" content="width=device-width,initial-scale=1">
49-
<meta charset="UTF-8">
50-
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
51-
</head>
52-
<body>
53-
<div id="app"></div>
54-
<script>
55-
window.$docsify = {
56-
//...
57-
}
58-
</script>
59-
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
60-
</body>
46+
<head>
47+
<meta name="viewport" content="width=device-width,initial-scale=1" />
48+
<meta charset="UTF-8" />
49+
<link
50+
rel="stylesheet"
51+
href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css"
52+
/>
53+
</head>
54+
<body>
55+
<div id="app"></div>
56+
<script>
57+
window.$docsify = {
58+
//...
59+
};
60+
</script>
61+
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
62+
</body>
6163
</html>
6264
```
6365

64-
Si instaló Python en su sistema, puede usarlo fácilmente para ejecutar un servidor estático para obtener una vista previa de su sitio.
66+
### Especificación de versiones de docsify
6567

66-
```bash
68+
?> Ten en cuenta que en ambos ejemplos a continuación, las URL de docsify deberán actualizarse manualmente cuando se lance una nueva versión importante de docsify (por ejemplo, `v4.x.x` => `v5.x.x`). Consulta el sitio web de docsify periódicamente para ver si se ha lanzado una nueva versión importante.
69+
70+
Especificar una versión importante en la URL (`@4`) permitirá que tu sitio reciba mejoras que no rompan la compatibilidad (es decir, actualizaciones "menores") y correcciones de errores (es decir, actualizaciones "de corrección") automáticamente. Esta es la forma recomendada de cargar los recursos de docsify.
71+
72+
```html
73+
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
74+
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
75+
```
76+
77+
Si prefieres bloquear docsify en una versión específica, especifica la versión completa después del símbolo `@` en la URL. Esta es la forma más segura de garantizar que tu sitio tenga la misma apariencia y se comporte de la misma manera, independientemente de los cambios realizados en las futuras versiones de docsify.
78+
79+
```html
80+
<link
81+
rel="stylesheet"
82+
href="//cdn.jsdelivr.net/npm/docsify@4.11.4/themes/vue.css"
83+
/>
84+
<script src="//cdn.jsdelivr.net/npm/docsify@4.11.4"></script>
85+
```
86+
87+
### Previsualización manual de tu sitio
88+
89+
Si tienes Python instalado en tu sistema, puedes usarlo fácilmente para ejecutar un servidor estático y previsualizar tu sitio.
90+
91+
```python2
6792
cd docs && python -m SimpleHTTPServer 3000
6893
```
6994

95+
```python3
96+
cd docs && python -m http.server 3000
97+
```
98+
7099
## Diálogo de carga
71100

72-
Si desea, puede mostrar un diálogo de carga antes de que docsify comience a mostrar su documentación:
101+
Si lo deseas, puedes mostrar un diálogo de carga antes de que docsify comience a renderizar tu documentación:
73102

74103
```html
75-
<!-- index.html -->
104+
<!-- index.html -->
76105

77-
<div id="app">Please wait...</div>
106+
<div id="app">Por favor, espera...</div>
78107
```
79108

80-
Debes de configurar el atributo `data-app` si cambiaste `el`:
109+
Debes establecer el atributo `data-app` si cambias `el`:
81110

82111
```html
83-
<!-- index.html -->
112+
<!-- index.html -->
84113

85-
<div data-app id="main">Please wait...</div>
114+
<div data-app id="main">Por favor, espera...</div>
86115

87-
<script>
88-
window.$docsify = {
89-
el: '#main'
90-
}
91-
</script>
116+
<script>
117+
window.$docsify = {
118+
el: '#main',
119+
};
120+
</script>
92121
```
93122

94-
Comparar la [configuración de el](/es/configuration.md#el).
123+
Compara [la configuración de `el`](/es/configuration.md#el).

0 commit comments

Comments
 (0)