Versiones
You can use the version script to cut a new documentation version based on the latest content in the docs folder. Ese conjunto específico de documentación se conservará y se podrá acceder incluso cuando la documentación en la carpeta docs cambie en adelante.
Cómo crear nuevas versiones
Run the following script to generate a starter versions page listing all the site versions:
yarn examples versions
This creates the pages/en/versions.js file.
You can edit this file later on to customize how you display the versions.
Add the following script to your package.json file if it doesn't already exist:
...
"scripts": {
"version": "docusaurus-version"
},
...
Ejecute el script con un argumento de línea de comando de la versión que desea crear. p.ej.,
yarn run version 1.0.0
Esto conservará todos los documentos actualmente en la carpeta docs y los pondrá a disposición como documentación para la versión 1.0.0.
If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.
Los documentos en la carpeta docs se considerarán parte de la versión next y estarán disponibles, por ejemplo, en url docs/next/doc1.html. Los documentos de la última versión usan url docs/doc1.html.
Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Los documentos de la versión 1.0.0 usarán la url docs/1.0.0/doc1.html mientras que 2.0.0 usará docs/doc1.html.
Patrones de versiones
You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. El orden de las versiones está determinado por el orden en que se crean las versiones, independientemente de cómo estén numeradas.
Almacenamiento de archivos para cada versión
Los documentos versionados se colocan en website/versioned_docs/version-${version} es el número de versión que proporcionó el script version.
The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.
Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.
Se crea un archivo website/versions.json la primera vez que se corta una versión y Docusaurus lo usa para detectar qué versiones existen. Cada vez que se agrega una nueva versión, se agrega al archivo versions.json.
Si desea cambiar la documentación de una versión anterior, puede acceder a los archivos para esa versión respectiva.
Funcionalidad de respaldo
Solo los archivos en la carpeta docs y los archivos de la barra lateral que difieren de los de la última versión se copiarán cada vez que se especifique una nueva versión. Si no hay cambios en las versiones, Docusaurus usará el archivo de la última versión con ese archivo.
Por ejemplo, existe un documento con el id original doc1 para la última versión, 1.0.0, y tiene el mismo contenido que el documento con el id doc1 en la carpeta docs. Cuando se crea una nueva versión 2.0.0, el archivo para doc1 no se copiará en versioned_docs/version-2.0.0/. Todavía habrá una página para docs/2.0.0/doc1.html, pero usará el archivo de la versión 1.0.0.
Cambiar el nombre de las versiones existentes
Para cambiar el nombre de un número de versión existente a otra cosa, primero asegúrese de que la siguiente secuencia de comandos se encuentre en su archivo package.json:
...
"scripts": {
"rename-version": "docusaurus-rename-version"
},
...
Ejecute la secuencia de comandos con argumentos de línea de comando de primero, el nombre de la versión actual, luego el segundo, el nombre de la nueva versión. p.ej.,
yarn run rename-version 1.0.0 1.0.1
Versiones y Traducciones
Si desea utilizar funciones de control de versiones y traducciones, el archivo crowdin.yaml debe configurarse para cargar y descargar documentos versionados desde y hacia Crowdin para su traducción. Los archivos traducidos y versionados irán a la carpetatranslated_docs/${language}/version-${version}/. For more information, check out the translations guide.