[devdocsgjs/main: 1213/1867] README: enable syntax highlighting
- From: Andy Holmes <andyholmes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devdocsgjs/main: 1213/1867] README: enable syntax highlighting
- Date: Fri, 19 Nov 2021 23:47:49 +0000 (UTC)
commit 64566960fd5c079f762614933607d3b135572cee
Author: Simon Legner <Simon Legner gmail com>
Date: Wed Nov 18 22:22:46 2020 +0100
README: enable syntax highlighting
README.md | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
---
diff --git a/README.md b/README.md
index 2796b993..595278e9 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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 .
@@ -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
@@ -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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]