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-directory
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog
    │   ├── 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

Directory Descriptions

Documentation Source Files: The docs directory contains example documentation files written in Markdown.
Blog: The website/blog directory contains examples of blog posts written in markdown.
Pages: The website/pages directory contains example top-level pages for the site.
Static files and images: The website/static directory contains static assets used by the example site.

Key Files

Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.

Preparation Notes

Deberá conservar los archivos website/siteConfig.js y website/core/Footer.js, pero puede editarlos como desee. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

However, you should keep the website/pages and website/static directories. You 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.