Unified · Split
| @@ -24,7 +24,7 @@ DevDocs is made of two pieces: a Ruby scraper that generates the documentation a · 23 unmodified lines | ||
| 24 | 24 | |
| 25 | 25 | DevDocs requires Ruby 2.6.x, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands: |
| 26 | 26 | |
| 27 | −``` | |
| 27 | +```sh | |
| 28 | 28 | git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs |
| 29 | 29 | gem install bundler |
| 30 | 30 | bundle install |
| @@ -40,7 +40,7 @@ The `thor docs:download` command is used to download pre-generated documentation · 9 unmodified lines | ||
| 40 | 40 | |
| 41 | 41 | Alternatively, DevDocs may be started as a Docker container: |
| 42 | 42 | |
| 43 | −``` | |
| 43 | +```sh | |
| 44 | 44 | # First, build the image |
| 45 | 45 | git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs |
| 46 | 46 | docker build -t thibaut/devdocs . |
| @@ -99,7 +99,7 @@ More information about [scrapers](./docs/scraper-reference.md) and [filters](./d · 52 unmodified lines | ||
| 99 | 99 | |
| 100 | 100 | The command-line interface uses [Thor](http://whatisthor.com). To see all commands and options, run `thor list` from the project's root. |
| 101 | 101 | |
| 102 | −``` | |
| 102 | +```sh | |
| 103 | 103 | # Server |
| 104 | 104 | rackup # Start the server (ctrl+c to stop) |
| 105 | 105 | rackup --help # List server options |
| @@ -116,10 +116,9 @@ thor docs:clean # Delete documentation packages · 10 unmodified lines | ||
| 116 | 116 | # Console |
| 117 | 117 | thor console # Start a REPL |
| 118 | 118 | thor console:docs # Start a REPL in the "Docs" module |
| 119 | −Note: tests can be run quickly from within the console using the "test" command. Run "help test" | |
| 120 | −for usage instructions. | |
| 121 | 119 | |
| 122 | −# Tests | |
| 120 | +# Tests can be run quickly from within the console using the "test" command. | |
| 121 | +# Run "help test" for usage instructions. | |
| 123 | 122 | thor test:all # Run all tests |
| 124 | 123 | thor test:docs # Run "Docs" tests |
| 125 | 124 | thor test:app # Run "App" tests |