2017-08-08 14:43:41 -04:00
---
id: site-preparation
title: Site Preparation
---
2018-02-12 21:13:26 -05:00
After [installing Docusaurus ](getting-started-installation.md ), 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.
2017-11-01 12:48:14 -04:00
## Directory Structure
As shown after you [installed Docusaurus ](getting-started-installation.md ), the initialization script created a directory structure similar to:
```bash
2018-05-24 00:01:33 -04:00
root-directory
2017-11-01 12:48:14 -04:00
├── docs-examples-from-docusaurus
2018-04-28 01:47:14 -04:00
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
2017-11-01 12:48:14 -04:00
│ └── exampledoc5.md
2018-05-24 00:01:33 -04:00
└── 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
2017-08-08 14:43:41 -04:00
```
2018-08-05 23:05:15 -04:00
> You may have already renamed the example blog (`website/blog-examples-from-docusaurus` to `website/blog`) and document (`docs-examples-from-docusaurus` to `docs`) directories when you [verified the installation](getting-started-installation.md##verifying-installation).
2018-02-12 21:13:26 -05:00
2018-08-05 23:05:15 -04:00
### Directory Descriptions
2017-08-08 14:43:41 -04:00
2018-08-05 23:05:15 -04:00
* **Documentation Source Files**: The `docs-examples-from-docusaurus` directory
contains example documentation files written in Markdown.
* **Blog**: The `website/blog-examples-from-docusaurus` directory contains examples of blog posts written in markdown.
* **Pages**: The `website/pages` directory contains example top-level pages for the site.
* **Static files and images**: The `website/static` directory contains static assets used by the example site.
2017-08-08 14:43:41 -04:00
2018-08-05 23:05:15 -04:00
### Key Files
* **Footer**: 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.
* **Configuration file**: The `website/siteConfig.js` file is the main
configuration file used by Docusaurus.
* **Sidebars**: The `sidebars.json` file contains the structure and ordering
of the documentation files.
## Preparation Notes
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` .