15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2026-01-01 08:53:11 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

docs: remove example mentions

This commit is contained in:
Yangshun Tay 2019-04-27 22:01:09 -07:00
parent 9426b033ee
commit ecf1f9a2c4
2 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/getting-started-preparation.md
View File

@ -11,14 +11,14 @@ As shown after you [installed Docusaurus](getting-started-installation.md), the
```bash
root-directory
├── docs-examples-from-docusaurus
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
│ └── exampledoc5.md
└── website
├── blog-examples-from-docusaurus
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md
@ -33,13 +33,11 @@ root-directory
└── static
```
> 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).
### Directory Descriptions
* **Documentation Source Files**: The `docs-examples-from-docusaurus` directory
* **Documentation Source Files**: The `docs` directory
contains example documentation files written in Markdown.
* **Blog**: The `website/blog-examples-from-docusaurus` directory contains examples of blog posts written in markdown.
* **Blog**: The `website/blog` 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.
@ -48,12 +46,12 @@ root-directory
* **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.
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. 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.
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`.

4
docs/tutorial-create-new-site.md
View File

@ -16,7 +16,7 @@ The following contents will be created for you in the directory you are in (TODO
```sh
├── Dockerfile
├── docker-compose.yml
├── docs-examples-from-docusaurus
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
@ -24,7 +24,7 @@ The following contents will be created for you in the directory you are in (TODO
│ └── exampledoc5.md
└── website
├── README.md
├── blog-examples-from-docusaurus
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md