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
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.jses 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-docusauruscontiene ejemplos de publicaciones de blog escritas en markdown. - La carpeta
docs-examples-from-docusauruscontiene ejemplos de archivos de documentación escritos en markdown. - La carpeta
website/pagescontiene páginas de ejemplo de nivel superior para el sitio. - La carpeta
website/staticcontiene recursos estáticos utilizados por el sitio de ejemplo. - El archivo
website/siteConfig.jses 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.