Site Preparation · Docusaurus

Despues instalar Docusaurus, ahora tienes un esqueleto de donde trabajar para tu sitio web especifico. A continuación se explica el resto de la estructura de Docusaurus con el objetivo de que prepares tu sitio web.

Estructura del Directorio

Como se muestra después de instalar Docusaurus, el script de inicialización creó una estructura de directorio similar a esta:

root-of-repo
├── 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
│   ├── core
│   │   └── Footer.js
│   ├── node_modules
│   ├── package.json
│   ├── pages
│   ├── sidebars.json
│   ├── siteConfig.js
│   └── static

Es posible que ya haya cambiado el nombre del blog de ejemplo (sitio web/blog-examples-from-docusaurus) y de los directorios de documentos (docs-examples-from-docusaurus) cuando verificando la instalación .

El archivo website/core/Footer.js es un componente de reacción que actúa como el pie de página del sitio generado por Docusaurus y debe ser personalizado por el usuario.
La carpeta website/blog-examples-from-docusaurus contiene ejemplos de publicaciones de blog escritas en markdown.
La carpeta docs-examples-from-docusaurus contiene ejemplos de archivos de documentación escritos en markdown.
La carpeta website/pages contiene páginas de ejemplo de nivel superior para el sitio.
La carpeta website/static contiene recursos estáticos utilizados por el sitio de ejemplo.
El archivo website/siteConfig.js es el archivo de configuración principal utilizado por Docusaurus.

Deberá conservar los archivos website/siteConfig.js y website/core/Footer.js, pero puede editarlos como desee.

Debe mantener las carpetas website/pages y website/static, pero puede cambiar el contenido dentro de ellas como desee. Como mínimo, debe tener un archivo en/index.js o en/index.htmlarchivo dentro. website/pages y una imagen para usar como su icono de encabezado dentro de website/static.