Skip to content

Commit

Permalink
Fix documentation of formatters defaults in README.md (#1163)
Browse files Browse the repository at this point in the history
  • Loading branch information
cw789 authored May 12, 2020
1 parent 549687b commit d272497
Showing 1 changed file with 0 additions and 6 deletions.
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,6 @@ You can ExDoc via the command line as follows:
$ ex_doc "PROJECT_NAME" "PROJECT_VERSION" path/to/project/ebin -m "PROJECT_MODULE" -u "https://github.com/GITHUB_USER/GITHUB_REPO" -l path/to/logo.png
```

4. By default, ex_doc produces HTML files, but, you can also create a EPUB document passing the option `--formatter epub`:

```bash
$ PATH_TO_YOUR_EXDOC/bin/ex_doc "PROJECT_NAME" "PROJECT_VERSION" path/to/project/ebin -m "PROJECT_MODULE" -u "https://github.com/GITHUB_USER/GITHUB_REPO" -l path/to/logo.png -f epub
```

For example, here are some acceptable values:

PROJECT_NAME => Ecto
Expand Down

0 comments on commit d272497

Please sign in to comment.