Translate

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

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

You may have already renamed the example blog (website/blog-examples-from-docusaurus and document (docs-examples-from-docusaurus) directories when you verified the installation.

• 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.