gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/how-to-work-on-the-docs-theme.md
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>

5
package.json
View File

@ -26,6 +26,7 @@
"develop": "npm-run-all ensure-env -p develop:*",
"develop:client": "cd ./client && npm run develop",
"develop:server": "cd ./api-server && npm run develop",
"develop:docs": "docsify serve ./docs --port 3200",
"docker:run-once": "npm run docker:init && npm run docker:install && npm run docker:seed",
"docker:clean": "docker-compose run -u root --rm freecodecamp bash -c \"rm -rf **/node_modules/* **/node_modules/..?* **/node_modules/.[!.]* node_modules/* node_modules/..?* node_modules/.[!.]*\"",
"docker:develop": "docker-compose up client api-server",
@ -34,7 +35,7 @@
"docker:seed": "docker-compose run --rm freecodecamp npm run seed",
"docker:test": "docker-compose -f docker-compose.tests.yml run --rm tests bash",
"docker:test:init": "docker-compose -f docker-compose.tests.yml run -u root --rm tests bash change_volumes_owner.sh",
"docs:serve": "docsify serve ./docs",
"docs:serve": "docsify serve ./docs -o --port 3200",
"ensure-env": "cross-env DEBUG=fcc:* node ./tools/scripts/build/ensure-env.js",
"e2e:dev:watch": "start-test develop ':3000/status/ping|8000' cypress:dev:watch",
"e2e:dev:run": "start-test develop ':3000/status/ping|8000' cypress:dev:run",
@ -122,4 +123,4 @@
}
},
"dependencies": {}
}
}