Site Preparation · Docusaurus

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

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.
The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
The website/pages directory contains example top-level pages for the site.
The website/static directory contains static assets used by the example site.
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.

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 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.