diff --git a/docs/en/1.10.x/site-preparation.html b/docs/en/1.10.x/site-preparation.html index 588d245b55..57a2a93e51 100644 --- a/docs/en/1.10.x/site-preparation.html +++ b/docs/en/1.10.x/site-preparation.html @@ -84,6 +84,7 @@
As shown after you installed Docusaurus, the initialization script created a directory structure similar to:
root-directory
+├── .gitignore
├── docs
│ ├── doc1.md
│ ├── doc2.md
@@ -107,25 +108,23 @@
docs
directory
-contains example documentation files written in Markdown.docs
directory contains example documentation files written in Markdown.website/blog
directory contains examples of blog posts written in markdown.website/pages
directory contains example top-level pages for the site.website/static
directory contains static assets used by the example site.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.website/siteConfig.js
file is the main
-configuration file used by Docusaurus.sidebars.json
file contains the structure and order
-of the documentation files.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.website/siteConfig.js
file is the main configuration file used by Docusaurus.sidebars.json
file contains the structure and order of the documentation files..gitignore
file lists the necessary ignore files for the generated site so that they do not get added to the git repo.You will need to keep the website/siteConfig.js
and website/core/Footer.js
files but may edit them as you wish. 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. At the bare minimum, you should have an en/index.js
or en/index.html
file inside website/pages
and an image to use as your header icon inside website/static
.