From 9931ed86d28a3ea64c9878536a4d2f91765f1d26 Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Mon, 12 Feb 2018 18:13:26 -0800 Subject: [PATCH] A bit more clarifcation on the install and prep pages (#446) --- docs/getting-started-installation.md | 2 +- docs/getting-started-preparation.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting-started-installation.md b/docs/getting-started-installation.md index c76e75e920..0d2fb25930 100644 --- a/docs/getting-started-installation.md +++ b/docs/getting-started-installation.md @@ -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. `yarn global add docusaurus-init` or `npm install --global 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: ```bash diff --git a/docs/getting-started-preparation.md b/docs/getting-started-preparation.md index 565fcc71d7..72378dcf6a 100644 --- a/docs/getting-started-preparation.md +++ b/docs/getting-started-preparation.md @@ -3,7 +3,7 @@ id: 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 @@ -31,6 +31,8 @@ root-of-repo │ └── 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/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. @@ -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 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. \ No newline at end of file +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`. \ No newline at end of file