Skip to content

Improve "API usage" section. #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve "API usage" section. #258

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,21 @@ codoCLI.generate "path/to/base/dir", options, (exitCode) -> process.exit exitCod

`option` is an object with options as above. Please note that they are *not* CamelCase (e.g. `min-coverage`
instead of `minCoverage`). Furthermore only global defaults will be used, project defaults are ignored
if Codo is used via API.
if Codo is used via API. Source files and extra files are lists called `inputs` and `extras` respectively.
An equivalent to the `.codoopts` file above would be:

```coffeescript
options =
name: 'Codo'
readme: 'README.md'
title: 'Codo Documentation'
private: true
quiet: true
extension: 'coffee'
output: './doc'
inputs: ['./src']
extras: ['LICENSE', 'CHANGELOG.md']
```

## Keyboard navigation

Expand Down