Skip to content

Commit

Permalink
README: enable syntax highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
simon04 committed Nov 18, 2020
1 parent b078b55 commit 6456696
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ DevDocs is made of two pieces: a Ruby scraper that generates the documentation a

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:

```
```sh
git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
gem install bundler
bundle install
Expand All @@ -40,7 +40,7 @@ The `thor docs:download` command is used to download pre-generated documentation

Alternatively, DevDocs may be started as a Docker container:

```
```sh
# First, build the image
git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
docker build -t thibaut/devdocs .
Expand Down Expand Up @@ -99,7 +99,7 @@ More information about [scrapers](./docs/scraper-reference.md) and [filters](./d

The command-line interface uses [Thor](http://whatisthor.com). To see all commands and options, run `thor list` from the project's root.

```
```sh
# Server
rackup # Start the server (ctrl+c to stop)
rackup --help # List server options
Expand All @@ -116,10 +116,9 @@ thor docs:clean # Delete documentation packages
# Console
thor console # Start a REPL
thor console:docs # Start a REPL in the "Docs" module
Note: tests can be run quickly from within the console using the "test" command. Run "help test"
for usage instructions.

# Tests
# Tests can be run quickly from within the console using the "test" command.
# Run "help test" for usage instructions.
thor test:all # Run all tests
thor test:docs # Run "Docs" tests
thor test:app # Run "App" tests
Expand Down

0 comments on commit 6456696

Please sign in to comment.