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.
- Fișierul
siteweb/core/Footer.js
este o componentă React ce acționează ca footer-ul pentru site-ul generat de Docusaurus și ar trebuii personalizat de către utilizator. - Dosarul
siteweb/exemple-blog-din-docusaurus
conține exemple de post-ări blog scrise în markdown. - Dosarul
exemple-documente-din-docusaurus
conține exemple de fișiere de documentație scrise în markdown. - Dosarul
siteweb/pagini
conține exemple ale paginilor de nivel de top pentru site. - Dosarul
siteweb/static
conține asset-uri statice folosite de site-ul exemplu. - Fișierul
siteweb/siteConfig.js
este fișierul principal de configurare utilizat de Docusaurus.
Va fi necesar să păstrați fișierele siteweb/siteConfig.js
și siteweb/core/Footer.js
, dar le puteți edita după cum doriți.
Ar trebuii să păstrați dosarele siteweb/pagini
și siteweb/static
, dar puteți să schimbați conținutul lor după cum doriți. Ca și cerință minimă ar trebuii să aveți un fișier en/index.js
sau en/index.html
înăuntrul la siteweb/pagini
și o imagine pe care să o utilizezi ca iconiță a header-ului înăuntrul la siteweb/static
.