3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 16:59:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

Move verifying Installation section to Installation doc (#435)

Browse source
This commit is contained in:
Agastya Darma 2018-02-13 09:04:17 +07:00 • committed by Joel Marcey
parent 69603c968e
commit c8781bedce
2 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

14
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. `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
@ -34,3 +34,15 @@ root-of-repo
```
> If you do not want to install the init script globally, you can install it locally and then run it via `npx docusaurus-init` or from the `node_modules` directory that is created via `./node_modules/.bin/docusaurus-init`. You may want to remove the created `package.json` file and `node_modules` directory after you run the script.
## Verifying Installation
Running the Docusaurus initialization script, `docusaurus-init`, produces a runnable, example website to base your site upon.
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. Run the local webserver via `yarn start` or `npm start`.
1. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
![](/img/getting-started-preparation-verify.png)

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

@ -42,16 +42,4 @@ You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` f
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.
## Verifying Installation
Running the Docusaurus initialization script, `docusaurus-init`, produces a runnable, example website to base your site upon.
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. Run the local webserver via `yarn start` or `npm start`.
1. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
![](/img/getting-started-preparation-verify.png)
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.