2.3 KiB
id | title |
---|---|
site-preparation | 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-directory
├── 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
│ ├── 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
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
directory contains examples of blog posts written in markdown. - The
docs-examples-from-docusaurus
directory contains example documentation files written in markdown. - The
website/pages
directory contains example top-level pages for the site. - The
website/static
directory contains static assets used by the example site. - The
website/siteConfig.js
file is the main configuration file used by Docusaurus.
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
directories, 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
.