3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 18:27:56 +02:00
Code Issues Projects Releases Packages Wiki Activity

A bit more clarifcation on the install and prep pages (#446)

Browse source
This commit is contained in:
Joel Marcey 2018-02-12 18:13:26 -08:00 • committed by GitHub
parent c8781bedce
commit 9931ed86d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/getting-started-installation.md
View file

@ -8,7 +8,7 @@ Docusaurus was designed from the ground up to be easily installed and used to ge
1. Go into the root of your GitHub repo directory where you will be creating the docs. 1. Go into the root of your GitHub repo directory where you will be creating the docs.
1. `yarn global add docusaurus-init` or `npm install --global docusaurus-init` 1. `yarn global add docusaurus-init` or `npm install --global docusaurus-init`
1. `docusaurus-init` 1. `docusaurus-init`
1. Verify the installation
Along with previously existing files and directories, your root directory will now contain a structure similar to: Along with previously existing files and directories, your root directory will now contain a structure similar to:
```bash ```bash

8
docs/getting-started-preparation.md
View file

@ -3,7 +3,7 @@ id: site-preparation
title: Site Preparation title: Site Preparation
--- ---
After [installing Docusaurus](getting-started-installation.md), you now have a skeleton to work from for your specific website. With a few changes, you can verify that Docusaurus was installed correctly by running the site locally. 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.
## Directory Structure ## Directory Structure
@ -31,6 +31,8 @@ root-of-repo
│ └── static │ └── 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](getting-started-installation.md##verifying-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/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. - The `website/blog-examples-from-docusaurus` folder contains examples of blog posts written in markdown.
- The `docs-examples-from-docusaurus` folder contains example documentation files written in markdown. - The `docs-examples-from-docusaurus` folder contains example documentation files written in markdown.
@ -40,6 +42,4 @@ root-of-repo
You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. 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`. 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.