Site Preparation
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-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.html
archivo dentro. website/pages
y una imagen para usar como su icono de encabezado dentro de website/static
.