Improve directory file tree (#614)

This commit is contained in:
Yangshun Tay 2018-04-27 22:47:14 -07:00 committed by GitHub
parent 38f93e750a
commit 327ef85770
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 92 additions and 92 deletions

View file

@ -22,22 +22,22 @@ Along with previously existing files and directories, your root directory will n
```bash ```bash
root-of-repo root-of-repo
├── docs-examples-from-docusaurus ├── docs-examples-from-docusaurus
── doc1.md ── doc1.md
── doc2.md ── doc2.md
── doc3.md ── doc3.md
── exampledoc4.md ── exampledoc4.md
│ └── exampledoc5.md │ └── exampledoc5.md
── website ── website
── blog-examples-from-docusaurus ── blog-examples-from-docusaurus
── 2016-03-11-blog-post.md │ ├── 2016-03-11-blog-post.md
└── 2017-04-10-blog-post-two.md └── 2017-04-10-blog-post-two.md
── core ── core
└── Footer.js └── Footer.js
── node_modules ── node_modules
── package.json ── package.json
── pages ── pages
── sidebars.json ── sidebars.json
── siteConfig.js ── siteConfig.js
│ └── static │ └── static
``` ```

View file

@ -12,22 +12,22 @@ As shown after you [installed Docusaurus](getting-started-installation.md), the
```bash ```bash
root-of-repo root-of-repo
├── docs-examples-from-docusaurus ├── docs-examples-from-docusaurus
── doc1.md ── doc1.md
── doc2.md ── doc2.md
── doc3.md ── doc3.md
── exampledoc4.md ── exampledoc4.md
│ └── exampledoc5.md │ └── exampledoc5.md
── website ── website
── blog-examples-from-docusaurus ── blog-examples-from-docusaurus
── 2016-03-11-blog-post.md │ ├── 2016-03-11-blog-post.md
└── 2017-04-10-blog-post-two.md └── 2017-04-10-blog-post-two.md
── core ── core
└── Footer.js └── Footer.js
── node_modules ── node_modules
── package.json ── package.json
── pages ── pages
── sidebars.json ── sidebars.json
── siteConfig.js ── siteConfig.js
│ └── static │ └── static
``` ```

View file

@ -14,15 +14,15 @@ Your site structure looks like the following:
```bash ```bash
root-of-repo root-of-repo
├── docs ├── docs
── website ── website
── blog ── blog
── core ── core
└── Footer.js └── Footer.js
── node_modules ── node_modules
── package.json ── package.json
── pages ── pages
── sidebars.json ── sidebars.json
── siteConfig.js ── siteConfig.js
│ └── static │ └── static
``` ```

View file

@ -18,18 +18,18 @@ Docusaurus provides some simple example pages in the `website/pages/en` director
```bash ```bash
root-of-repo root-of-repo
├── docs ├── docs
── website ── website
── blog ── blog
── core ── core
└── Footer.js └── Footer.js
── node_modules ── node_modules
── package.json ── package.json
── pages ── pages
── index.js │ ├── index.js
── users.js │ ├── users.js
└── help.js └── help.js
── sidebars.json ── sidebars.json
── siteConfig.js ── siteConfig.js
│ └── static │ └── static
``` ```

View file

@ -49,23 +49,23 @@ When you run docusaurus-init, you will see a structure similar to:
``` ```
root-of-repo root-of-repo
├── docs-examples-from-docusaurus ├── docs-examples-from-docusaurus
── doc1.md ── doc1.md
── doc2.md ── doc2.md
── doc3.md ── doc3.md
── exampledoc4.md ── exampledoc4.md
│ └── exampledoc5.md └── exampledoc5.md
── website ── website
── blog-examples-from-docusaurus ── blog-examples-from-docusaurus
── 2016-03-11-blog-post.md │ ├── 2016-03-11-blog-post.md
│ └── 2017-04-10-blog-post-two.md └── 2017-04-10-blog-post-two.md
── core ── core
│ └── Footer.js └── Footer.js
── node_modules ── node_modules
── package.json ── package.json
── pages ── pages
── sidebars.json ── sidebars.json
── siteConfig.js ── siteConfig.js
│ └── static └── static
``` ```
With the exception of node_modules and package.json, all the directories and files you see are where you customize and add content to your Docusaurus-based website. The docs folder is where you add your markdown that represents your documentation; the blog folder is where you add your markdown for your [blog posts](https://docusaurus.io/docs/en/blog.html); siteConfig.js is where you make most of the [customizations](https://docusaurus.io/docs/en/site-config.html) for your site; sidebars.json is where you maintain the layout and content of the [sidebar](https://docusaurus.io/docs/en/navigation.html) for your documentation; the pages folder is where you add [custom](https://docusaurus.io/docs/en/custom-pages.html) pages for your site; the static folder is where all of your static assets go (e.g., css stylesheets and images); and the core folder is where you can customize core components of the site, in this case the footer. With the exception of node_modules and package.json, all the directories and files you see are where you customize and add content to your Docusaurus-based website. The docs folder is where you add your markdown that represents your documentation; the blog folder is where you add your markdown for your [blog posts](https://docusaurus.io/docs/en/blog.html); siteConfig.js is where you make most of the [customizations](https://docusaurus.io/docs/en/site-config.html) for your site; sidebars.json is where you maintain the layout and content of the [sidebar](https://docusaurus.io/docs/en/navigation.html) for your documentation; the pages folder is where you add [custom](https://docusaurus.io/docs/en/custom-pages.html) pages for your site; the static folder is where all of your static assets go (e.g., css stylesheets and images); and the core folder is where you can customize core components of the site, in this case the footer.
@ -77,20 +77,20 @@ Docusaurus is written primarily in JavaScript and [React](https://facebook.githu
``` ```
root-of-Docusaurus root-of-Docusaurus
├── lib ├── lib
── core ── core
── server ── server
── generate.js │ ├── generate.js
── server.js │ ├── server.js
│ └── ...and more files └── ...and more files
── static ── static
── build-files.js ── build-files.js
── copy-examples.js ── copy-examples.js
── generate-feed.js ── generate-feed.js
── publish-gh-pages.js ── publish-gh-pages.js
── rename-version.js ── rename-version.js
── start-server.js ── start-server.js
── versions.js ── versions.js
│ └── write-translations.js └── write-translations.js
``` ```
The key files here are build-files.js and start-server.js. There are many similarities between these two files: `build-files.js` is used to build the physical artifacts for serving by an external web server. `start-server.js` is used to run the Docusaurus server and locally test your site. Both go through the following general process to take all of the markdown and configuration to create a runnable website: The key files here are build-files.js and start-server.js. There are many similarities between these two files: `build-files.js` is used to build the physical artifacts for serving by an external web server. `start-server.js` is used to run the Docusaurus server and locally test your site. Both go through the following general process to take all of the markdown and configuration to create a runnable website:
@ -115,16 +115,16 @@ The final structure of your compiled site will look similar to:
``` ```
build build
├── website ├── website
── CNAME ── CNAME
── blog ── blog
── css ── css
── docs ── docs
── en ── en
── help.html # custom page ── help.html # custom page
── img ── img
── index.html # landing page ── index.html # landing page
── sitemap.xml ── sitemap.xml
│ └── users.html # custom page └── users.html # custom page
``` ```
## Community ## Community