Docusaurus

next

Translate

Comandos de la CLI

Docusaurus proporciona un conjunto de scripts para ayudarlo a generar, abastecer e implementar su sitio web. Estos scripts se pueden invocar con el comando run cuando se utiliza Yarn o npm. Algunos comandos comunes son:

Ejecución desde la línea de comandos

Los scripts se pueden ejecutar usando Yarn o npm. Si ya ha consultado nuestra guía de introducción, es posible que ya esté familiarizado con el comando start. Es el comando que le dice a Docusaurus que ejecute el script docusaurus-start que genera el sitio y arranca un servidor, y generalmente se invoca así:

yarn run start

El mismo script puede invocarse usando npm:

npm run start

Para ejecutar un script en particular, simplemente reemplace el comando start en los ejemplos anteriores con el comando asociado con su script.

Usando argumentos

Algunos comandos admiten argumentos opcionales. Por ejemplo, para iniciar un servidor en el puerto 8080, puede especificar el argumento --port cuando se ejecuta start:

yarn run start --port 8080

Si ejecuta Docusaurus utilizando npm, puede seguir utilizando los argumentos de la línea de comando insertando un -- entre npm run <command> y los argumentos del comando:

npm run start -- --port 8080

Configuración

Estos scripts se configuran con la clave "scripts" en su archivo website/package.json como parte del proceso de instalación. Si necesita ayuda para configurarlas nuevamente, consulte la Guía de instalación .

Docusaurus proporciona algunas asignaciones predeterminadas que le permiten ejecutar comandos siguiendo las convenciones de Nodo. En lugar de escribir docusaurus-start siempre, puede escribir yarn run start o npm start para lograr lo mismo.

Comandos

<autogenerated_table_of_contents>

Referencia

docusaurus-build

Alias: build.

Genera un sitio web estático, aplicando traducciones si es necesario. Útil para construir el sitio web antes de la implementación.

Ver también docusaurus-start.

docusaurus-examples [feature]

Alias: examples

Cuando no se especifica ninguna función, establece un sitio web de ejemplo configurado mínimamente en su proyecto. Este comando se trata en profundidad en la guía de preparación del sitio . Especifique una característica translations o versions para generar los archivos de ejemplo adicionales para esa función.

docusaurus-publish

Alias: publish-gh-pages

construcciones, luego implementa el sitio web estático en paginas de GitHub. Este comando se debe ejecutar durante el paso de implementación en Circle CI y, por lo tanto, espera que se definan algunas variables de entorno:

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

  • GIT_USER: El usuario de git que se asociará con la implementación del commit.

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    e.g.,

GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages


The following environment variables are [set by CircleCI](https://circleci.com/docs/1.0/environment-variables/) during the build process.

* `CIRCLE_BRANCH`: El branch del git asociada con el commit que desencadenó la ejecución del CI.
* `CI_PULL_REQUEST`: Se espera que sea cierto si la ejecución de CI actual fue desencadenada por un commit en una solicitud de extracción.

The following should be set by you in `siteConfig.js` as `organizationName` and `projectName`, respectively. If they are not set in your site configuration, they fall back to the [CircleCI environment](https://circleci.com/docs/1.0/environment-variables/).

* `CIRCLE_PROJECT_USERNAME`: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
* `CIRCLE_PROJECT_REPONAME`: The name of the Git repo, e.g. "Docusaurus".

You can learn more about configuring automatic deployments with CircleCI in the [Publishing guide](/docs/es-ES/next/publishing.html).

* * *

### `docusaurus-rename-version <currentVersion> <newVersion>`

Alias: `rename-version`

Cambia el nombre de una versión existente de los documentos a un nuevo nombre de versión.

Consulte la [ guía de control de versiones ](/docs/es-ES/next/versiones.html#renaming-existing-verssions) para obtener más información.

* * *

### `docusaurus-start [--port <number>]`

Alias: `start`.

Este script creará el sitio web estático, aplicará las traducciones si es necesario y luego iniciará un servidor local. El sitio web se servirá desde el puerto 3000 de manera predeterminada.

* * *

### `docusaurus-version <version>`

Alias: `version`

Genera una nueva versión de los documentos. Esto dará como resultado una nueva copia de su sitio que se generará y almacenará en su propia carpeta versioned. Útil para capturar instantáneas de documentos API que se asignan a versiones específicas de su software. Acepta cualquier cadena como número de versión.

Consulte la [ guía de control de versiones ](/docs/es-ES/next/versiones.html) para obtener más información.

* * *

### `docusaurus-write-translations`

Alias: `write-translations`

Escribe el inglés para cualquier cadena que deba traducirse a un archivo `website/i18n/en.json` file. El script examinará todos los archivos en `website/pages/en`y a través del archivo `siteConfig.js` y otros archivos de configuración para buscar cadenas en inglés que luego serán traducidas en Crowdin. Consulte la [ guía de traducción ](/docs/es-ES/next/traducción.html) para obtener más información.
← VersionesCaracteristicas de Markdown →