1.3.3

Translate

Instalación

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Instalando Docusaurus

Hemos creado un sencillo script que configurará toda la infraestructura para usted:

  1. Asegúrese de tener la última versión de Node instalada. También recomendamos que instale Yarn también.

    Tienes que estar en el node> = 8.x y yarn> = 1.5.

  2. Cree un proyecto, si no existe, y cambie el directorio a la raíz de este proyecto.

    Va a crear los documentos en este directorio. El directorio raíz puede contienen otros archivos. El script de instalación de Docusaurus creará dos nuevos directorios: docs-examples-from-docusaurus y website.

    Comúnmente, un proyecto GitHub existente o recién creado será la ubicación de su sitio Docusaurus, pero eso no es obligatorio para usar Docusaurus.

  3. Ejecute el script de instalación de Docusaurus: npx docusaurus-init.

    Si no tiene el Node 8.2+ o si prefiere instalar Docusaurus globalmente, ejecute yarn global add docusaurus-init o npm install --global docusaurus-init. Después de eso, ejecute docusaurus-init.

Verificar la instalación

Along with previously existing files and directories, your root directory will now contain a structure similar to:

root-directory
├── docs-examples-from-docusaurus
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog-examples-from-docusaurus
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Ejecutando el sitio web como ejemplo

Después de ejecutar el script de inicialización de Docusaurus, docusaurus-init como descrito en la sección Instalación , tendrá un ejecutable, el sitio web de ejemplo para usar como base de su sitio. A ejecutar:

  1. En su raíz, cambie el nombre de docs-examples-from-docusaurus a docs.

  2. cd webiste

  3. Cambie el nombre de blog-examples-from-docusaurus a blog.

  4. Desde el directorio website, ejecute el servidor web local usando yarn start o npm start.

  5. Cargue el sitio de ejemplo en http://localhost:3000 si aún no se abrió automáticamente.

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

Ejecutar el servidor detrás de un proxy

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

SET NO_PROXY = localhost
yarn start (o npm run start)

Updating Your Docusaurus Version

En cualquier momento después de instalar Docusaurus, puede verificar su versión actual de Docusaurus ingresando en el directorio website y escribiendo yarn outdated docusaurus or npm outdated docusaurus.

You will see something like this:

$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
warning package.json: No license field
warning No license field
info Color legend : 
 "<red>"    : Major Update backward-incompatible updates 
 "<yellow>" : Minor Update backward-compatible features 
 "<green>"  : Patch Update backward-compatible bug fixes
Package    Current Wanted Latest Package Type    URL                                          
docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
✨  Done in 0.41s.

Si no hay una salida de versión notable de los comandos obsoletos, entonces está actualizado.

You can update to the latest version of Docusaurus by:

yarn upgrade docusaurus --latest

o

npm update docusaurus

Si encuentra errores después de la actualización, intente borrar su caché de Babel (generalmente está en un directorio temporal o ejecute el servidor Docusaurus (por ejemplo, yarn start) con la configuración de entorno BABEL_DISABLE_CACHE = 1.

Preparación del sitio →