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
@@ -27,6 +27,9 @@
│ └── 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.
+
- 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.
- The
website/blog-examples-from-docusaurus
folder contains examples of blog posts written in markdown.
@@ -37,7 +40,6 @@
You will need to keep the website/siteConfig.js
and website/core/Footer.js
files, but may edit them as you wish.
You should keep the website/pages
and website/static
folders, but 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
.
-The website/blog-examples-from-docusaurus
and docs-examples-from-docusaurus
folders contain example blog and document markdown files. As shown below when you verify that the example site runs correctly, if you wish to run Docusaurus with these files, you need to rename the folders to website/blog
and docs
, respectively.