Skip to content

Commit

Permalink
chore(Readme): update to use consistent code-blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
hasezoey committed Sep 7, 2022
1 parent 6abf8b3 commit 0550a76
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions Readme.md
Expand Up @@ -8,18 +8,24 @@ Dox is a JavaScript documentation generator written with [node](http://nodejs.or

Install from npm:

$ npm install -g dox
```sh
npm install -g dox
```

## Usage Examples

`dox(1)` operates over stdio:

$ dox < utils.js
...JSON...
```sh
$ dox < utils.js
...JSON...
```

to inspect the generated data you can use the `--debug` flag, which is easier to read than the JSON output:
to inspect the generated data you can use the `--debug` flag, which is easier to read than the JSON output:

$ dox --debug < utils.js
```sh
dox --debug < utils.js
```

utils.js:

Expand Down Expand Up @@ -139,7 +145,7 @@ Usage: dox [options]

### Programmatic Usage

``` js
```js
var dox = require('dox'),
code = "...";

Expand Down Expand Up @@ -440,15 +446,15 @@ dox.contextPatternMatchers.push(function (str, parentContext) {

Comments and their associated bodies of code may be flagged with "!" to be considered worth ignoring, these are typically things like file comments containing copyright etc, however you of course can output them in your templates if you want.

```
```js
/**
* Not ignored.
*/
```

vs

```
```js
/*!
* Ignored.
*/
Expand All @@ -460,8 +466,10 @@ You may use `-S`, `--skipSingleStar` or `{skipSingleStar: true}` to ignore `/* .

Install dev dependencies and execute `make test`:

$ npm install -d
$ make test
```sh
npm install -d
make test
```

## License

Expand Down

0 comments on commit 0550a76

Please sign in to comment.