fix(docs): local server config, run alongside fCC

This commit is contained in:
Mrugesh Mohapatra
2020-10-04 05:02:42 +05:30
committed by Mrugesh Mohapatra
parent 56a46fd700
commit c064bf0022
2 changed files with 21 additions and 6 deletions

View File

@ -21,21 +21,35 @@ Typically you would not need to change any configuration or build the site local
Clone freeCodeCamp:
```sh
```console
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
docsify serve docs
```
Install `docsify`:
```sh
```console
npm install -g docsify
```
and serve the `/docs` directory
```sh
```console
docsify serve docs
```
Alternatively, if you have installed freeCodeCamp locally (see the local setup guide), we bundle the CLI with the development tools so you can run `npm run docs:serve` from the root of the repo.
Alternatively, if you have installed freeCodeCamp locally (see the local setup guide), we bundle the CLI with the development tools so you can run any of the below commands as needed from the root of the repo:
### Serve and launch the documentation site only
```console
npm run docs:serve
```
### Serve the documentation site alongside freeCodeCamp locally:
```console
npm run develop
```
> The documentation site should be available at <http://localhost:3200>